Developers using this project should already have Python3, pip and node installed on their local machines.
You should create databases and fill them with data
createdb suora
psql suora < suora.psql
export POSTGRESS_HOST=localhost:5432
export POSTGRESS_DATABASE=suora
python3 -m venv venv
. venv/bin/activate
From the backend folder run pip install requirements.txt. All required packages are included in the requirements file.
To run the application run the following commands:
export FLASK_APP=flaskr
export FLASK_ENV=development
flask run
or
FLASK_APP=flaskr FLASK_ENV=development flask run
The application is run on http://127.0.0.1:5000/ by default and is a proxy in the frontend configuration.
From the frontend folder, run the following commands to start the client:
npm install // only once to install dependencies
npm start
By default, the frontend will run on localhost:3000.
In order to run tests navigate to the backend folder and run the following commands:
createdb suora_test
psql suora_test < suora.psql
python test_flaskr.py
The first time you run the tests, omit the dropdb command.
All tests are kept in that file and should be maintained as updates are made to app functionality.
- Base URL: At present this app can only be run locally and is not hosted as a base URL. The backend app is hosted at the default,
http://127.0.0.1:5000/, which is set as a proxy in the frontend configuration. - Authentication: This version of the application does not require authentication or API keys.
- Response codes
- Messages
- Error types
- Organized by resource
- Include each endpoint
- Sample request
- Arguments including data types
- Response object including status codes and data types
@muhammet-mucahit