Third Places Project
Overview
Third Places Project is a project that will seek to connect Philadelphians to comfortable public spaces, with the focus being on finding places spontaneously.
This project was started as part of Code for Philly's Launchpad 2023 event.
Joining the regular meetings
We host weekly meetings both in person and remotely. This is largely where we make decisions and set up collaborative pairing sessions to get large chunks of work done.
The best way to find out about our meetings is joining the #third-places-project channel on the Code for Philly Slack.
Contributing
Please read the contributing guidelines to find out how you can volunteer.
Setup
Requirements
You will need to have a working understanding of using a Unix-like system via a terminal or shell and the instructions below use Bash commands.
In order to run this app, you will need to have the following libraries installed on your machine:
- Node: Javascript runtime
- npm: Node Package Manager
- Django: python web framework
- Python 3.9+
Note: These installations will not be required locally once we have the project containerized, the container will hand that.
Create .env file
Why a .env?
We will be using a .env file to share environment variables with each of the Docker containers and separate our environment variables from our code.
Make the actual file
Duplicate the .env.sample file and rename it to .env
Note
The .env file is ignored by git and so any changes will have to be communicated to the team to make sure API keys etc. stay aligned from dev to dev.
Start the servers
To run all servers (React, Django, & PostgreSQL):
# Build the containers from images
docker-compose build
# Run the servers
docker-compose up
# OR for a single command to do both
docker-compose up --buildPort Numbers
Access the following ports from localhost to access their respective services
| Service | Port |
|---|---|
| React | 4321 |
| Django | 8321 |
Api Reference
/api/: Hello world!/users/:GET,POSTusers/users/{id}:GET,PUTspecific user details