Backend:
Step 1: Open VSCode, Clone and Fetch this branch from Github.
Step 2: In VSCode terminal, make sure you're in the root folder where you can see requirements.txt
.
Step 3: Create a virtual environment by entering in the terminal: pipenv shell
.
(Assumming you already installed pipenv
and pip
.)
Step 4: Install requirements by entering: pip install -r requirements.txt
.
Step 5: (Optional) In the terminal, enter coverage run manage.py test
to run unit tests,
then enter coverage report
to see % code coverage.
Connect to PostgreSQL database on Railway.app:
Step 1: Create a .env
file in the root folder, put in:
DATABASE_URL=postgresql://postgres:[email protected]:33804/railway
, then save.
Step 2: Open backend\settings.py
, then un-comment these two lines (64, 65):
database_url = os.environ.get('DATABASE_URL')
DATABASES["default"] = dj_database_url.parse(database_url)
(by removing the #
before each of them, then save the file)
Step 3: In the terminal, enter python manage.py runserver
to start the backend server with port 8000.
Frontend:
Step 1: Open another VSCode Terminal, enter cd frontend
to go inside the frontend
folder.
Step 2: Create a .env
file inside the frontend
folder,
put in REACT_APP_API_BASE_URL=http://localhost:8000/api
, then save.
Step 3: In the terminal, enter npm ci
, then npm start
.
Step 4: Open localhost:3000
and try out the features.
Note: May have to install missing packages and modules: try to Google the errors and solutions/commands to install packages are usually on Stackoverflow.
Available Features:
- Log in / Register
- Profile Management
- Request a Quote
- Quote History
- Pricing Module
- Unit Tests with Code Coverage over 90%