This is a job finder where users can create a job or accept a job.
The docs directory contains documentation relevant to the project.
This project uses the Django Framework to resolve requests and mutate objects stored in a PostgreSQL database. For the frontend, we are using React. Nginx is used to act as a reverse proxy for HTTP requests. Docker is used to ease the build process of the app in development (and production in the future).
All the frontend code is in frontend, and likewise for the backend.
General naming convention and organization should try to follow this guide which was chosen arbitrarily to make sure there is at least some baseline standard.
Credit note: A lot of the Docker stuff in this repo is from this blog post.
First, install:
dockerinstructions for Mac/Windows instructions for Linuxdocker-composeinstructions
Then, clone the repo and cd into it
git clone git@github.com:Simponic/cs3450-team-one.git jobfinder
cd jobfinderYou will need to set the following variables in a .env file in the root directory:
- REACT_APP_MAPS_API_KEY (contact Logan for one if you don't want to make one on Google Cloud)
And run the DB, Frontend, and Backend with one command:
sudo docker-compose up -d --buildThe app should be live at http://localhost:81.
You might find yourself needing to do migrations. To do so, first list all the running docker containers:
$ sudo docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
be5d05526668 project-v2_backend "python manage.py ru…" 6 minutes ago Up 6 minutes 8000/tcp project-v2_backend_1
959151ab9c21 project-v2_frontend "docker-entrypoint.s…" 15 minutes ago Up 12 minutes 3000/tcp project-v2_frontend_1
50536f1737d5 postgres:14.1 "docker-entrypoint.s…" 18 minutes ago Up 13 minutes 0.0.0.0:5438->5432/tcp, :::5438->5432/tcp project-v2_db_1And select the container ID of the image running the backend; in this case be5d05526668. Start a shell.
$ sudo docker exec -it be5d05526668 /usr/local/bin/python3 manage.py migrate
Operations to perform:
Apply all migrations: admin, auth, authentication, contenttypes, sessions
...To seed initial values into the database:
$ sudo docker exec -it be5d05526668 /usr/local/bin/python3 manage.py loaddata <fixture-file-name>
Current fixture file names:
contact_form.json, job_type.json
* For contact forms, please make sure to create at least 1 job and 2 accounts before seeding.
... To seed an owner account into the database:
$ sudo docker exec -it be5d05526668 /usr/local/bin/python3 manage.py create_owner --email='yourEmail@email.com' --phone-number='4352225555' --password='examplePassword23#231$' --first-name='YourFirstName' --last-name='YourLastName' --home-address='4205 Old Main Hill Logan, UT 84322'Most communication between members are done over Discord.
Development is version-controlled with git (obviously). GitHub Projects (an alternative to Trello) is used to assign team members tasks, track issues, and further coordinate development efforts. These integrate very nicely with the workflow of git; closing tasks when Pull Requests are made, containerizing conversations on features, etc.
Once you've cloned the repo (and assuming you're a "collaborator"), you have write-access; changes you make can be directly committed to the main branch. Though this should be done only for small changes, like documentation, which are approved by the team.
Generally, the workflow of making a feature branch starts with the assigning of a task/issue on the backlog to a team member. Once work is able to begin on that task, the assigned team member will put that task card into the "In Progress" column. Then that team member, on their local environment, will branch off main with a relevant branch name. All further development on this task will continue on that branch until it is ready to be reviewed.
Once the task is ready to be reviewed, the assigned team member will push their local feature branch onto origin and create a Pull Request to merge their branch into main so others can also view their work. The pull request will be under heavy subjugation in Code Review, and if it survives the perilous trials of fire, will be merged into the main branch.
Please see out Testing.md document for our testing.
Deployment will be automated with Docker. Possibly hosted on a Rasperry Pi or something.
When deployed, the following list of accounts will be accessible from the site:
| Emails | Password | Role |
|---|---|---|
| owner@mailinator.com | password | owner |
| joeschmoe@mailinator.com | password | customer |
| workerone@mailinator.com | password | worker |
| workertwo@mailinator.com | password | worker |
| worker3@mailinator.com | password | worker |
| worker4@mailinator.com | password | worker |
| schmoejoe@mailinator.com | password | customer |
To connect to the database hosted with docker, first find the container id associated with the postgres image:
$ sudo docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
1a2205c294ab project-v2_reverse_proxy "/docker-entrypoint.…" 40 hours ago Up 26 minutes 0.0.0.0:81->80/tcp, :::81->80/tcp project-v2_reverse_proxy_1
4a497a6396cf project-v2_frontend "docker-entrypoint.s…" 40 hours ago Up 26 minutes 3000/tcp project-v2_frontend_1
5154452292bd postgres:14.1 "docker-entrypoint.s…" 40 hours ago Up 26 minutes 0.0.0.0:5438->5432/tcp, :::5438->5432/tcp project-v2_db_1
d20c2566bcbe project-v2_backend "python manage.py ru…" 40 hours ago Up 26 minutes 8000/tcp project-v2_backend_1And connect to a psql "repl":
$ sudo docker exec -it 5154452292bd /usr/bin/psql -U postgres
psql (14.1 (Debian 14.1-1.pgdg110+1))
Type "help" for help.
postgres=# In the case that you need to install a new npm package, do the same as above to find the container id of the frontend, then:
$ sudo docker exec -it 4a497a6396cf /usr/local/bin/npm install <packages>And make sure to let your teammates know they need to sudo docker exec -it 4a497a6396cf /usr/local/bin/npm install .