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

https://github.com/fr4nkln11/onlynotes

A simple flask app that stores notes
https://github.com/fr4nkln11/onlynotes

bootstrap5 flask python3

Last synced: 5 months ago
JSON representation

A simple flask app that stores notes

Awesome Lists containing this project

README

          

# OnlyNotes - Uncomplicated Note-Taking App.
Begin your streamlined note-taking journey today with this uncomplicated app, enabling your ideas to shine as you embrace the elegance of simplicity.

![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)
![Bootstrap](https://img.shields.io/badge/bootstrap-%238511FA.svg?style=for-the-badge&logo=bootstrap&logoColor=white)
![Flask](https://img.shields.io/badge/flask-%23000.svg?style=for-the-badge&logo=flask&logoColor=white)
![Render](https://img.shields.io/badge/Render-%46E3B7.svg?style=for-the-badge&logo=render&logoColor=white)
![CSS3](https://img.shields.io/badge/css3-%231572B6.svg?style=for-the-badge&logo=css3&logoColor=white)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)

## Installation
To install and run OnlyNotes locally or for development, follow these steps:

1. Clone this repository to your local machine
2. Navigate to the project directory
3. Create a virtual environment: `python -m venv venv`
4. Activate the virtual environment:
* On macOS/Linux: `source venv/bin/activate`
5. Run `pip install -r requirements.txt` to install necessary dependencies
6. Create Environment varibles for `FLASK_APP` and `DATABASE_URI`
* `export FLASK_APP=src`
* `export DATABASE_URI=sqlite:///database.db`
7. Start the development server: `flask run`

## Usage
To use OnlyNotes, visit [here](https://flask-notes-app.onrender.com/)

## Screenshots
![Screenshot 1](src/static/screenshot.png)

## Contributions
We welcome contributions from the community! If you find any issues or have suggestions for new features, please submit them through our issue tracker. We also encourage you to fork this repository and submit pull requests for any bug fixes or enhancements.

To contribute to OnlyNotes, follow these steps:

1. Fork this repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.