https://github.com/lukaskoeller/notus
simple notes application
https://github.com/lukaskoeller/notus
fastapi notes productivity python react
Last synced: 3 months ago
JSON representation
simple notes application
- Host: GitHub
- URL: https://github.com/lukaskoeller/notus
- Owner: lukaskoeller
- Created: 2023-05-24T20:52:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T21:11:11.000Z (almost 2 years ago)
- Last Synced: 2025-07-19T01:53:10.406Z (12 months ago)
- Topics: fastapi, notes, productivity, python, react
- Language: TypeScript
- Homepage:
- Size: 16.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# notus
## This app is still WIP and not usable yet…
This is a simple notes app using markdown.
## Gettings started
On the first time, create a virtual environment:
```sh
python3 -m venv env
```
This creates a virtual environment in the `./env` directory which is also added to `.gitignore`.
Start the virtual environment:
```sh
source ./env/bin/activate
```
Verify that the virtual environment is active:
```sh
which python
```
On the first time, install dependencies:
```sh
python -m pip install fastapi "uvicorn[standard]" sqlmodel
```
Run the application:
```sh
uvicorn main:app
```
To watch for changes, run the command with the [`--reload`](https://sqlmodel.tiangolo.com/tutorial/fastapi/simple-hero-api/#uvicorn-reload) option.
The backend will run on port `8000`.
To deactivate the virtual environment, run:
```sh
deactivate
```
Open a new terminal and run the web app:
```sh
cd app
npm run dev
```
Check the docs at `http://localhost:8000/docs`.
Login to the MySQL monitor via:
```sh
mysql -u root -p
```
## ToDos
- [ ] Add API to add, edit and delete notes connected to a user.
- [ ] Connect endpoints with react app.
- [ ] Show tags in app.
- [ ] Add syntax highlighting to preview.
- [ ] Add search feature
- [ ] More do be added…