tendaitt/usap-directory

USAP Directory

An online directory for alumni of the United Students Achievers Program.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Installing

Running the tests

Automated Tests

Coding Style Tests

Deployment

Built With

• Flask
• React
• PostgreSQL
• Docker
• ElasticSearch

Contributing

Please read CONTRIBUTING.md to learn how you can contribute to the project.

Code of Conduct

Please read CODE_OF_CONDUCT.md for details on our code of conduct.

Versioning

We use SemVer for versioning. For the versions available, see the releases on this repository.

Authors

• Tendai Mudyiwa (@tendaitt)
• Felix Gondwe (@felixgondwe)
• Contributors

License

This project is licensed under the MIT License. More information can be found here.