These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

• Node 20.11.0+
• Go 1.21.6+
• Docker (Recommended)

1. Clone the repo

   git clone https://github.com/MRSessions/simple-pocket-crm.git

Note: You can run the project separately with the default ports 8090 (PocketBase) and 3000 (Vue). The defult .env file is using VITE_POCKETBASE_URL to set the PocketBase URL. You can change this to point to a different PocketBase instance or if you change the port.

1. In the pocketbase directory, run the following command to start the PocketBase server

   go run . serve #Runs PocketBase on default port 8090

2. In the vue-client directory, install NPM packages

   npm install

3. In the vue-client directory, run the following command to start the Vue server

   npm run dev #Runs Vue on default port 3000

• The easiest way to run is use Docker Compose

  docker-compose up --build

  or to recreate the container

  docker-compose up --build --force-recreate

(back to top)

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature (git checkout -b feature/AmazingFeature) or Bug Fix (git checkout -b bug/AmazingBugFix)
3. Commit your Changes (git commit -m 'Add some AmazingFeature or some AmazingBugFix')
4. Push to the Branch (git push origin feature/AmazingFeature or git push origin bug/AmazingBugFix)
5. Open a Pull Request
   1. If your change includes quite a bit of change, please document the changes in detail in the pull request.

(back to top)

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Matt Sessions - @MRSessions

Project Link: https://github.com/MRSessions/simple-pocket-crm

(back to top)