Git Product home page Git Product logo

personal-crm's Introduction

Personal CRM app

A lightweight web app to log who you're seeing/meeting/making plans with. Built mainly as an exercise in learning React and docker-compose. This can be productionised on any sort of web hosting service -- I'm using Digital Ocean.

Launched, it should look like this:

App Interface

Developer notes

NB: many of the docker-compose design patterns come from this article.

Launching with docker-compose

Locally

sudo docker-compose up --build
sudo docker-compose down -v

In production

Need to manually seed the database at initial startup as we don't destroy it on restart (for obvious reasons). Don't execute the create_db command unless you want to wipe data!

This also expects there to be a .env.prod key in the project root directory that mirrors .env.dev but with production credentials (and sets BACKEND_ENV=production).

sudo docker-compose -f docker-compose.yml -f docker-compose.prod.yml up --build
sudo docker-compose exec backend python manage.py create-db
sudo docker-compose exec backend python manage.py seed-db

Manually starting various Docker containers

Networking

sudo docker network create personal-crm-net

Running Postgres

Note: password is fake, obvs

sudo docker pull postgres
sudo docker run --name personal-crm-db -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 --net personal-crm-net -it postgres
export SQLALCHEMY_DATABASE_URI=postgresql://postgres:mysecretpassword@localhost:5432/postgres
python manage.py create-db
python manage.py seed-db

Starting backend

sudo docker build . -t personal-crm-backend
sudo docker run --rm --name personal-crm-backend -e SQLALCHEMY_DATABASE_URI=postgresql://postgres:mysecretpassword@personal-crm-db:5432/postgres --net personal-crm-net -p 5000:5000 -it personal-crm-backend

Starting frontend

npm run start
sudo docker build . -t personal-crm-frontend
sudo docker run --rm --name personal-crm-frontend --net personal-crm-net -p 4000:4000 -it personal-crm-frontend

Running fully manually

Frontend

npm start

Backend

poetry shell
SQLALCHEMY_DATABASE_URI=sqlite:///./test.db uvicorn src.main:app --reload --port 5000

(and then manually create & seed the database)

To run a database migration

Follow Alembic's instructions

Building for Pi

Use Docker's buildx tool. Following steps in this article, commands were something like...

sudo docker buildx create --name pi-builder --platform linux/arm/v7
sudo docker buildx use pi-builder
sudo docker buildx inspect --bootstrap
sudo docker buildx build backend/Dockerfile --load --tag personal-crm_backend:pi
sudo docker save -o ~/personal-crm-backend-pi.tar personal-crm_backend:pi
# ...and again for frontend image

Then you can scp the built dockerfiles to Pi to run...

sudo scp ~/personal-crm-backend-pi.tar [email protected]:/home/pi/personal-crm-backend-pi.tar
sudo docker load -i personal-crm-backend-pi.tar

personal-crm's People

Contributors

clwatkins avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.