Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anabartos/stars-wars-rest-api2
https://github.com/anabartos/stars-wars-rest-api2
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/anabartos/stars-wars-rest-api2
- Owner: anabartos
- Created: 2023-01-19T09:07:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-23T17:15:14.000Z (about 1 year ago)
- Last Synced: 2023-11-23T18:26:14.492Z (about 1 year ago)
- Language: Python
- Size: 17.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE_LOG.md
Awesome Lists containing this project
README
# Flask Boilerplate for Profesional Development
[](https://gitpod.io/from-referrer/)
## Features
- Extensive documentation [here](https://start.4geeksacademy.com).
- Integrated with Pipenv for package managing.
- Fast deloyment to heroku with `$ pipenv run deploy`.
- Use of `.env` file.
- SQLAlchemy integration for database abstraction.
## Installation (automatic if you are using gitpod)
> Important: The boiplerplate is made for python 3.7 but you can easily change the `python_version` on the Pipfile.
The following steps are automatically runned withing gitpod, if you are doing a local installation you have to do them manually:
```sh
pipenv install;
mysql -u root -e "CREATE DATABASE example";
pipenv run init;
pipenv run migrate;
pipenv run upgrade;
```
## How to Start coding?
There is an example API working with an example database. All your application code should be written inside the `./src/` folder.
- src/main.py (it's where your endpoints should be coded)
- src/models.py (your database tables and serialization logic)
- src/utils.py (some reusable classes and functions)
- src/admin.py (add your models to the admin and manage your data easily)
For a more detailed explanation, look for the tutorial inside the `docs` folder.
## Remember to migrate every time you change your models
You have to migrate and upgrade the migrations for every update you make to your models:
```bash
$ pipenv run migrate #(to make the migrations)
$ pipenv run upgrade #(to update your databse with the migrations)
```
# Manual Installation for Ubuntu & Mac
⚠️ Make sure you have `python 3.6+` and `MySQL` installed on your computer and MySQL is running, then run the following commands:
```sh
$ pipenv install (to install pip packages)
$ pipenv run migrate (to create the database)
$ pipenv run start (to start the flask webserver)
```
## Publish/Deploy your website!
This boilerplate it's 100% read to deploy with Render.com and Herkou in a matter of minutes. Please read the [official documentation about it](https://start.4geeksacademy.com/deploy).