Skip to content

Commit ff15ebf

Browse files
committed
GH-4: Create a README for basic run
1 parent 869b8bc commit ff15ebf

File tree

2 files changed

+26
-15
lines changed

2 files changed

+26
-15
lines changed

README.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,6 @@
22

33
Easy to setup OAuth2 social authentication mechanism with support for several auth providers.
44

5-
## Demo
6-
7-
This sample application is made to demonstrate the use of the [**fastapi-oauth2**](./fastapi_oauth2) package.
8-
9-
## Running the application
10-
11-
```bash
12-
uvicorn main:app --reload
13-
```
14-
15-
## TODO
16-
17-
- Make the [**fastapi-oauth2**](./fastapi_oauth2) depend
18-
on (overuse) the [**social-core**](https://github.com/python-social-auth/social-core)
19-
205
## Features
216

227
- Integrate with any existing FastAPI project (no dependencies of the project should stop the work of

examples/demonstration/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Demonstration
2+
3+
This sample application is made to demonstrate the use of the [**fastapi-oauth2**](./fastapi_oauth2) package.
4+
5+
## Installation
6+
7+
You got to have `fastapi-oauth2` installed in your environment. To do so, run the following command in
8+
the `pyproject.toml` file's directory.
9+
10+
### Regular install
11+
12+
```bash
13+
pip install fastapi-oauth2
14+
```
15+
16+
### Install in editable mode
17+
18+
```bash
19+
pip install -e .
20+
```
21+
22+
## Running the application
23+
24+
```bash
25+
uvicorn main:app --reload
26+
```

0 commit comments

Comments
 (0)