# 🐍 Python GraphQL API 

Python GraphQL API template application.

It's a multi user TODO list application with a clean architecture implementation.

## 🚀 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

You need: 
- `Python 3` installed on your local machine. You will find installation steps for your platform on the
 python [official website](https://www.python.org/downloads/).
- I recommend `pipenv` for virtual environment setup.

### 🖥 Installing

Clone the project.

Create a virtual environment and install dependencies with:
```shell script
pipenv install
```

Activate the virtual environment with:
```shell script
pipenv shell
```

Then launch the development server using:
```shell script
uvicorn app.main:app --reload
```
The development server and GraphiQL API explorer are available on  http://0.0.0.0:8000. 

🎉 Enjoy!

## 🧪 Running the tests (Under construction)

Explain how to run the automated tests for this system

### Break down into end to end tests

Explain what these tests test and why

```shell script
Give an example
```

### 💅 And coding style tests

Coding style is enforced using black and isort. 

```shell script
isort .
black .
```

## ☁️ Deployment

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

## 🛠 Built with

- [FastAPI](https://fastapi.tiangolo.com/) - FastAPI framework, high performance, easy to learn, fast to code, ready for production
- [Graphene](https://graphene-python.org/) - GraphQL in Python Made Easy

## 👩‍💻 Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## 🆚 Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/rjNemo/project/tags).

## ✒️ Authors

- **Ruidy** - _Initial work_ - [Ruidy](https://github.com/rjNemo)

See also the list of [contributors](https://github.com/rjNemo/project/contributors) who participated in this project.

## 👩‍⚖️ License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## 🤗 Acknowledgments

- Hat tip to anyone whose code was used
- Inspiration
- _etc._