Falcon

All in one platform for intercity bus operators

Demo

Live

Documentation

Documentation

Development setup 🛠

Steps to locally setup development after cloning the project.

Create a virtualenv with python 3.10+ and activate it

python -m venv venv
source venv/bin/activate

Then start the server with

make build

This single command should

• Install all your dependencies
• Make and apply all DB migrations
• Spin up a server running on port 8000

Testing 🧪

We use the classic unit test framework to run django tests testing each endpoint
The broad approach is to create mock data for each test with setup and check specific
test case. Although in production scenario you would add integration or End to end testing.

To run the entire test suite in one go simply run

make test

CI/CD? ♾️

You can actually run our continous integration by executing

make ci

This should run

- formatting pipeline
- linting pipeline
- testing
- coverage

Coverage 🎪

The CI pipeline itself runs all the tests for the project and generates an html report
in the root directory of the project.

Admin Interface 👩‍💼

• For convenience we have access to an admin interface provided by django.
• All data models are hooked up to the admin interface to verify if data has been correctly populated in the database.
• But to access the admin you would need to create a super user by running the following

make superuser

Provide a username, password, email and then you can access admin at http://localhost:8000/admin/

Features ✨

• Uses logging module quite frequently for easy debugging
• Unit tests to verify functionality as per requirements
• Fast response time
• Make file for faster setup and reusability