Skip to content

Commit 9ad90d9

Browse files
author
App Generator
committed
Release v1.0.0
- Persistance: SQLite3 - Stack: Flask / Flask-JWT-Extended / SQLAlchemy - API: - Sign UP: `/api/users/register` - Sign IN: `/api/users/login` - Logout: `/api/users/logout` - Edit User: `/api/users/edit`
1 parent df89dcd commit 9ad90d9

File tree

4 files changed

+83
-5
lines changed

4 files changed

+83
-5
lines changed

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Change Log
2+
3+
## [v1.0.0] 2021-07-20
4+
### Stable release
5+
6+
- Persistance: SQLite3
7+
- Stack: Flask / Flask-JWT-Extended / SQLAlchemy
8+
- API:
9+
- Sign UP: `/api/users/register`
10+
- Sign IN: `/api/users/login`
11+
- Logout: `/api/users/logout`
12+
- Edit User: `/api/users/edit`
13+

LICENSE.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# MIT License
2+
3+
Copyright (c) 2019 - present [AppSeed](http://appseed.us/)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+
23+
<br />
24+
25+
---
26+
For more information regarding licensing, please contact AppSeed < *support @ appseed.us* >

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
1-
## api-server-flask
1+
## Flask API Server
22

3-
`api-server-flask` is a boilerplate starter template designed to help you quickstart your Flask based REST API server development. It has all the ready-to-use bare minimum essentials.
3+
Flask Starter with JWT authentication, and **SQLite** persistance - Provided by **AppSeed** [App Generator](https://appseed.us/app-generator).
4+
It has all the ready-to-use bare minimum essentials.
45

6+
<br />
57

6-
## Features
8+
> Features:
79
810
- APIs: Signup, Login with (email, password), Logout, Edit User
911
- SQLAlchemy + SQLite
1012
- Configs
1113
- Requirements
1214
- Tests: SignUp, Login
1315

16+
<br />
17+
18+
> Support:
19+
20+
- Github (issues tracker), Email: **support @ appseed.us**
21+
- **Discord**: [LIVE Support](https://discord.gg/fZC6hup) (registered AppSeed Users)
22+
23+
<br />
24+
25+
![Nodejs API Server - Open-source Nodejs Starter provided by AppSeed.](https://user-images.githubusercontent.com/51070104/124414813-142aa180-dd5c-11eb-9279-6b082dadc51a.png)
26+
27+
<br />
1428

1529
## Table of Contents
1630

@@ -77,7 +91,7 @@ or
7791
$ flask run
7892
```
7993

80-
use `flask-restx`' swagger dashboard to test APIs, or alternatively use `postman`
94+
use `flask-restx`' swagger dashboard to test APIs, or use `POSTMAN`
8195

8296

8397
## Project Structure
@@ -96,6 +110,7 @@ api-server-flask/
96110
└── tests.py
97111
```
98112

113+
<br />
99114

100115
## Modules
101116

@@ -106,7 +121,11 @@ This application uses the following modules
106121
- Flask-JWT-Extended
107122
- pytest
108123

109-
110124
## Testing
111125

112126
Run tests using `pytest tests.py`
127+
128+
<br />
129+
130+
---
131+
Flask API Server - provided by AppSeed [App Generator](https://appseed.us)

package.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "api-server-flask",
3+
"version": "1.0.0",
4+
"description": "Open-source Flask API Server",
5+
"scripts": {},
6+
"repository": {
7+
"type": "git",
8+
"url": "https://github.com/app-generator/api-server-flask"
9+
},
10+
"bugs": {
11+
"url": "https://github.com/app-generator/api-server-flask/issues",
12+
"email": "support@appseed.us"
13+
},
14+
"author": "AppSeed App Generator <support@appseed.us> (https://appseed.us)",
15+
"engines": {
16+
"node": ">=10.0.0"
17+
},
18+
"dependencies": {},
19+
"devDependencies": {}
20+
}

0 commit comments

Comments
 (0)