https://github.com/bonface221/smart-notes-
Smart notes -django app
https://github.com/bonface221/smart-notes-
Last synced: 3 months ago
JSON representation
Smart notes -django app
- Host: GitHub
- URL: https://github.com/bonface221/smart-notes-
- Owner: bonface221
- License: mit
- Created: 2022-06-10T13:19:10.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-06-10T19:27:27.000Z (almost 3 years ago)
- Last Synced: 2025-01-12T06:43:12.406Z (5 months ago)
- Language: Python
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Smart Notes
An application where users can:
* Sign up
* Sign in (authentication)
* add their notes
* Perform CRUD operations
## Getting Started
* Fork the repository
* git clone the project to your local machine
* Set up a virtual environment in the project folder
```
$ pipenv shell
```
### Prerequisites
*get pipenv
```
Debian- sudo apt install pipenv
```
```
Windows- pip install --user pipenv
```
```
Locate python interpreter
$ pipenv --py
/Users/kennethreitz/.local/share/virtualenvs/test-Skyy4vre/bin/python
```
*get all requirements in the Pipfile.lock
```
$ pipenv install
```
### Installing
Ensure that the MODE in the .env is set to development ('dev'), which will automatically set debug to true.
Now run the following command
```
python3.9 manage.py runserver
```
And view the site at the port provided which is most likely 127.0.0.1:8000
## Deployment
To deploy on heroku:
* Have a Procfile in the project root;
* Update requirements.txt file with all the requirements in the project root;
* Have Gunicorn to requirements.txt;
* Have runtime.txt to specify the correct Python version in the project root;
* Ensure configuration whitenoise to serve static files.
* Add a heroku remote by logging in
* Configure all the settings in .env on heroku (set MODE to 'prod' on heroku)
* git push to heroku
* git push database and migrate to heroku server
## Built With
* Python Programming Language
* Django Web Framework
## Versioning
Find all the versions used in the pipfile.lock :
## Authors
* **Bonface221** - [bonface221](https://github.com/bonface221/insta-clone)
## License
This project is licensed under the [MIT License](./LICENSE)