An open API service indexing awesome lists of open source software.

https://github.com/fandredev/nlw-connect

A application with Flask in the Rocketseat NLW Connect event
https://github.com/fandredev/nlw-connect

cerberus flask python sqlite

Last synced: 12 months ago
JSON representation

A application with Flask in the Rocketseat NLW Connect event

Awesome Lists containing this project

README

          

## NLW Connect: :technologist:

I created with Rocketseat an application in Python from scratch, and you will learn about the main tools of the language that we use in the market today. We will work with a practical approach and understand the concepts that encompass the fundamentals applied in the project. We will develop an API for event registration, allowing you to manage events and their subscribers efficiently, with creation, update and data control operations. In this track, we will work with Flask, which will allow us to create the API, Postman to test and validate our routes. We will use SQLAlchemy to deal with databases and we will use Pytest, a library for creating automated tests.

# Stack used

python,flask,git,vscode,sqlite

### Other tools:

- [dbeaver](https://dbeaver.io/)
- [pip](https://pypi.org/project/pip/)
- [pytest](https://docs.pytest.org/en/stable/)
- [SQLAlchemy](https://www.sqlalchemy.org/)
- [Cerberus](https://docs.python-cerberus.org/)

## Clone this repo

```
git clone git@github.com:fandredev/nlw-connect.git
```

## Go to directory

```
cd nlw-connect
```

## Creating a python environment

```
python -m venv venv
```

## Install dependencies

```
pip install -r requirements.txt
```

## Create a database

You need to create a three tables in sqlite (using dbeaver or no) to run this project. Please, read the init/schema.sql to understand the sql commands to create your own database.

![alt text](readme-images/database.png)

## Run integration tests

```
pytest
```

## Run coverage HTML

```
coverage html
```
## Run coverage Report

```
coverage report
```

## Run server

```
python run.py
```

##### **Notes**: Use the 'NLW Connect.postman_collection.json' file to see routes and requests.

![Preview Collection Postman](readme-images/collection_postman.png)

## :mailbox_with_no_mail: Contacts

E-mail: profissionalf.andre@gmail.com

Linkedin: https://www.linkedin.com/in/devfandre/

Pórtfolio: https://developer-felipe-andre.vercel.app/

Youtube: https://www.youtube.com/@thistate/

Blog: https://medium.com/@thistate

# References

- [Rocketseat](https://www.rocketseat.com.br/)