Journal Policy Tracker: Backend

This is the backend repository for the Journal Policy Tracker web application.

Database Schema Design for the Journal Policy Tracker can be found here

Tech Stack used

Local Environment Setup

Installing dependencies

Poetry

After cloning this repo, you can use Poetry to create the virtual environment (virtualenv) and install the dependencies on it.

First, spawn a shell with the virtualenv activated (you can use exit/Ctrl+D to leave the shell/virtualenv):

$ poetry shell

Then, install the dependencies:

$ poetry install

If installation succeeds, you should be able to see the current installed Flask version:

$ flask --version

Running

To run the flask application:

$ poetry run python -m codecompl

Contribute to this project

Our Slack Community: Slack Invite

Contributions are welcome 🎉🎉

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull request so that we can review your changes

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

Starware

This project is Starware.
This means you're free to use the project, as long as you star its GitHub repository.
Your appreciation makes us grow and glow up. ⭐

Zain-Muiz/journal-policy-tracker-backend