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

https://github.com/micahondiwa/enwriters_v1


https://github.com/micahondiwa/enwriters_v1

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# Enwriters
- This is alx specialization portfolio project.
### How to use this repo - getting started:

1. Clone the repo.
2. Cd to the root directory.
3. Create a python virtual environment (venv):
```
python -m venv venv
```
or
```
python3 -m venv venv
```
4. Activate the venv:
- In windows:
```
.\venv\Scripts\activate
```
or
```
venv\Scripts\Activate.ps1
```
- In Mac:
```
source venv/bin/activate
```
5. Install all packages/libraries using requirements.txt file:
```
pip install -r requirements.txt
```

6. You can now run the app:
```
python .\run.py
```

7. Check the API endpoints from a browser:
```
http://127.0.0.1:5000/docs
```
8. start the frontend:
```
cd frontend
```

```
npm start
```

9. View the landing page:
```
http://localhost:3000
```
### Files and Folders

Contributers:
- [Micah Ondiwa](https://github.com/micahondiwa)
- [tobias-baraka](https://github.com/tobias-barakaa)