i always forget my friends birthdays so i want to write api that i save my friends and family birthdays on it and buy them nice gift for them so i start as easy as possibles and then i will make it better and refactor it.
Follow these steps to set up the project locally:
-
Clone the repository:
git clone https://github.com/amirQuf/MyfriendsList.git
-
Create a virtual environment:
python3 -m venv .env
-
Activate the virtual environment:
source .env/bin/activate -
Install the project dependencies:
pip install -r requirements.txt
-
Start the development server:
python main.py
The project should now be up and running on http://0.0.0.0:8080/.
you can find documents on docs/
Explain how to use your Django project. Provide instructions for common tasks, such as creating an admin account, accessing different features, or interacting with the application's APIs.
Outline the key features and functionality of your Django project. Highlight what makes it unique or valuable to users. You can provide a bullet list or go into detail about each feature.
- docker,...
- manga problem
- documeting codes
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Implement your changes and ensure they are thoroughly tested.
- Commit your changes and push them to your fork.
- Submit a pull request, explaining the changes you have made.
Please adhere to the project's coding style, conventions, and guidelines. Be respectful and considerate when participating in discussions and addressing issues.
Specify the license under which your Django project is distributed. For example, you can use the MIT License, GNU General Public License (GPL), or any other open-source license that aligns with your project's requirements. Make sure to include any license-related files or links in your project's repository.
Feel free to customize this README file based on your specific Django project. Include relevant details, instructions, and sections that best represent your project and provide value to users and potential contributors.
Good luck with your Django project!