White Paper is a web application developed using the Python Django framework. This project serves as a digital notepad, allowing users to create, edit, and manage notes efficiently. It emphasizes simplicity, scalability, and an intuitive user experience for seamless note-taking.
- Backend: Python, Django Framework
- Frontend: HTML, CSS, JavaScript
- Database: SQLite (default), with options for PostgreSQL/MySQL
- Others: Django Rest Framework (if applicable), Bootstrap (if applicable)
- Python 3.8+ installed on your system.
- Virtual Environment tools such as
venvorvirtualenv. - SQLite (default) or a preferred database like PostgreSQL/MySQL (optional).
-
Clone the repository:
git clone https://github.com/ygowthamr/WhitePaper.git cd WhitePaper -
Set up a virtual environment:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
-
Install dependencies:
pip install -r requirements.txt
-
Configure the database:
- For the default SQLite database:
No additional configuration is required. - For PostgreSQL/MySQL, update the
DATABASESsettings insettings.py.
- For the default SQLite database:
-
Apply migrations:
python manage.py migrate
-
Run the development server:
python manage.py runserver
-
Access the application:
Open your browser and navigate tohttp://127.0.0.1:8000.
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature-name
- Commit your changes and push:
git add . git commit -m "Description of changes" git push origin feature-name
- Submit a pull request.
This project is licensed under the MIT License.
We are grateful to the following contributors who have worked on this project
Feel free to reach out for any queries or suggestions at [[email protected]]. 😊