https://github.com/fer-bar/bookmarker-api
This is an RestApi built with Flask and Flask-RESTful
https://github.com/fer-bar/bookmarker-api
flask python rest-api swagger
Last synced: about 1 month ago
JSON representation
This is an RestApi built with Flask and Flask-RESTful
- Host: GitHub
- URL: https://github.com/fer-bar/bookmarker-api
- Owner: Fer-Bar
- Created: 2022-03-04T22:24:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-13T04:18:36.000Z (almost 4 years ago)
- Last Synced: 2025-03-16T22:42:09.388Z (over 1 year ago)
- Topics: flask, python, rest-api, swagger
- Language: Python
- Homepage: https://bookmarker--api.herokuapp.com/
- Size: 29.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📎Bookmarker-API
> This is an RestApi built with Flask and Flask-RESTful.
>
>
> 
# 👨💻Installation
## 📄Pre-Requirements
- Python Installed (Recommended version 3.8 or above)
- Pip Package Manager (pip)
## ⚙️How to use it?
1. Download this repository with git clone or by clicking the download as archive on this page
```
git clone https://github.com/Fer-Bar/selenium-bot-python.git
```
Go to the project directory.
```
cd bookmarksrestapi
```
2. Create a virtual environment:
### 🪟Windows:
```
py -m venv venv
```
Once created you can activate it.
```
venv\Scripts\activate.bat
```
### 🐧Unix or MacOS:
```
pip install virtualenv
virtualenv venv
```
Once created you can activate it.
```
source venv/bin/activate
```
3. Install dependencies with `pip install -r requirements.txt`. Make sure everything is installed properly with `pip freeze`.
4. The last step is run the [main.py](main.py) file, if you want you can change the host and the port. For example:
```
app.run(host='localhost', port=9000, debug=True)
```
## 🧪 Tests
- To run tests, run the following command:
```
python -m pytest -v
```
## 🔃Migrations
- To run the migrations, just run the following commands:
This command adds a `migrations` directory in the root of your project. This is a directory where all the migration scripts are going to be stored.
```
flask db init
```
The next step in the process is to create an initial migration, using the `migrate` command:
```
flask db migrate -m "Initial migration."
```
Then you can apply the migration to the database:
```
flask db migrate -m "Initial migration."
```
## 😎 Author
👤 **Fernando Barrientos**
* Website: [fer-bar.github.io](https://fer-bar.github.io/Portfolio/)
* Github: [Fer-Bar](https://github.com/Fer-Bar)
* LinkedIn: [Fernando Barrientos](#)