Notewell is a set of tools that help you take short and concise notes and study more efficiently.
Run it locally »
License
·
Report Bug
·
Request Feature
-
Python 3.9 (or higher)
-
Pipenv
$ python -m pip install -U pipenv
-
Node v16.11.1 (or higher)
-
npm 8.1.3 (or higher)
$ npm install -g npm@8.1.3
The snippet assumes that you already have a version of npm installed
Download the content and place it in the moderation_models
folder (not the individual model.tar.gz files).
- Clone the Notewell repo
In this documentation, we will clone the repo in the home directory of the user, however it is recommended that you put it in a better location. Just keep in mind that you will have to change it in the cd
commands later on 🙂
$ git clone https://github.com/false-positive/notewell ~/notewell
- Setup the Django development database
$ cd ~/website/
$ pipenv install && pipenv shell
$ python manage.py migrate
$ python manage.py loaddata fixtures/*.json
$ python manage.py changepassword admin
- Run the Django development server
$ cd ~/website/
$ python manage.py runserver
This will start the Django development server on http://localhost:8000.
- Run the Vite server (for the editor)
In order for the editor to work, you have to start the Vite server on port http://localhost:3000:
$ cd ~/editor/
$ npm install && npm run dev
Note: Don't access http://localhost:3000. The Django server on :8000 automatically connects to it
- Head on over to http://localhost:8000/login/ and login as
admin
with the password you set earlier.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
See LICENSE for more details.