devvspaces/hng-calendar-app

Calendar app for team Gear. Will contain ORM and API Documentation.

Team Gear Calendar App

---

Few lines describing your project.

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• TODO
• Contributing
• Team
• Acknowledgments

🧐 About

Calendar app for team Gear

🏁 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

What things you need to install the software and how to install them.

1. Install Python

Installing

A step by step series of examples that tell you how to get a development env running.

Setup virtual Enviroment

python -m venv venv

Activate virtual enviroment

Windows

venv\Scripts\activate

Linux

source venv/bin/activate

Install dependencies

pip install -r requirements.txt

🔧 Running the tests

Explain how to run the automated tests for this system.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

This is using flake8 to check for coding style

flake8

🎈 Usage

Running fastapi server

uvicorn main:app --reload

Check the swagger docs at http://localhost:8000/docs

🚀 Deployment

Add additional notes about how to deploy this on a live system.

⛏️ Built Using

• FastAPI - FastAPI framework, high performance, easy to learn, fast to code, ready for production
• SQLAlchemy - ORM (Object Relational Mapper)

✍️ Team

• @devvspaces - Team Member

🎉 Acknowledgements

• HNG Internship