MyMangaList

A REST API to organize my manga list. How much manga do you read?

📝 Prerequisites

Before you begin, ensure you have met the following requirements:

Setup the project by. clone the project and install the dependencies

git clone https://github.com/malaquiasdev/mymangalist.git
cd mymangalist
npm install
pipenv install

Local development. Create a .env file at the root of the project. Make sure you follow the .env.example file as a guide.
```
serverless offline
```
To learn more about the capabilities of serverless-offline, please refer to its GitHub repository.
Testing. We are using the python unittest to run our suites.
```
python -m unittest discover test
```
Bundling dependencies. We are using a Pipfile file and the serverless-python-requirements plugin. Every lib installed here will be automatically injected to Lambda package during build process. For more details about the plugin's configuration, please refer to official documentation. The package.json file is here to manager the serverless framework version and plugins. It is a prerequisites.
Deployment.
```
serverless deploy --aws-profile {YOUR_PROFILE_HERE} --stage {dev/prd/test/v1}
```
For more details about the command, please refer to official documentation.

Thanks goes out to all these wonderful people (emoji key):

Please respect our Code of Conduct, in short:

MyMangaList is released under the GNU GENERAL PUBLIC LICENSE.