https://github.com/devvspaces/hng-calendar-app
Calendar app for team Gear. Will contain ORM and API Documentation.
https://github.com/devvspaces/hng-calendar-app
Last synced: 11 months ago
JSON representation
Calendar app for team Gear. Will contain ORM and API Documentation.
- Host: GitHub
- URL: https://github.com/devvspaces/hng-calendar-app
- Owner: devvspaces
- Created: 2022-11-13T09:14:51.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-11-13T13:00:44.000Z (over 3 years ago)
- Last Synced: 2025-07-05T17:34:11.710Z (11 months ago)
- Language: Python
- Size: 8.79 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
Team Gear Calendar App
[]()
[](https://github.com/kylelobo/The-Documentation-Compendium/issues)
[](https://github.com/kylelobo/The-Documentation-Compendium/pulls)
[](/LICENSE)
---
Few lines describing your project.
## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](../TODO.md)
- [Contributing](../CONTRIBUTING.md)
- [Team](#authors)
- [Acknowledgments](#acknowledgement)
Calendar app for team Gear
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#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](https://www.python.org/downloads/)
### 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
```bash
pip install -r requirements.txt
```
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
```bash
flake8
```
Running fastapi server
```bash
uvicorn main:app --reload
```
Check the swagger docs at `http://localhost:8000/docs`
Add additional notes about how to deploy this on a live system.
- [FastAPI](https://fastapi.tiangolo.com/) - FastAPI framework, high performance, easy to learn, fast to code, ready for production
- [SQLAlchemy](https://www.sqlalchemy.org/) - ORM (Object Relational Mapper)
- [@devvspaces](https://github.com/devvspaces) - Team Member
- HNG Internship