- About the Project
- Technologies Used
- Additional Resources
- Lead Developers
- License
- Acknowledgements
- Contact
- Special Thanks
Litterbox is a platform designed for students to express creativity through blogging. It offers features that foster interaction and collaboration among users, aiming to create a supportive and vibrant community.
To empower students with a platform that encourages sharing knowledge, fostering creativity, and building a sense of community.
- User Authentication: Secure user login, registration, email verification, password reset, and account management (deactivate or delete).
- Profile Management: Users can personalize their profiles by updating personal information, profile picture, and bio.
- Blog Post Management: Users can create, edit, delete, categorize, and tag blog posts.
- Content Navigation: Search, filter, and sort options to help users explore posts, users, tags, and categories efficiently.
- Comment and Feedback System: Users can comment on posts, reply to others, like/dislike comments, and delete their own comments.
- Calendar System: View school events, set reminders, and add personal events or deadlines to a calendar.
This project is licensed under the MIT License. See the LICENSE file for details.
![Gantt Chart Image](https://github.com/rei-naissance/Litterbox/raw/Calendar-System/static/readme_files/functional_requirements.png)
![Gantt Chart Image](https://github.com/rei-naissance/Litterbox/raw/Calendar-System/static/readme_files/gantt_chart.png)
![Entity Relationship Diagram Image](https://github.com/rei-naissance/Litterbox/raw/Calendar-System/static/readme_files/erd2.png)
![Google Drive Image](https://github.com/rei-naissance/Litterbox/raw/Calendar-System/static/readme_files/figma.png)
Thank you to all contributors who have helped improve this project. Your contributions are greatly appreciated!
Contributors are the backbone of open-source projects. By contributing to a project, you can help improve the code, add new features, fix bugs, or improve the documentation. Here's how you can become a contributor to Litterbox:
-
Fork the Project:
- Fork the project by clicking the "Fork" button at the top right of the repository page. This will create your own copy of the repository where you can freely make changes.
-
Clone Your Fork:
-
After forking, clone your forked repository to your local machine by running:
git clone https://github.com/rei-naissance/Litterbox.git
-
-
Create a Feature Branch:
-
Navigate to your project folder and create a new branch for your feature or bug fix. Use a naming convention like
feature/my-new-feature
orbugfix/fix-issue-name
to keep your branches organized.git checkout -b feature/my-new-feature
-
-
Make Changes:
- Work on the changes you want to contribute. This could be anything from fixing bugs, adding new features, improving existing code, or even updating the documentation.
-
Commit Your Changes:
-
Once you're satisfied with the changes, commit them with a clear and concise commit message explaining what you changed.
git commit -m "Add user authentication feature"
-
-
Push Changes to Your Fork:
-
After committing, push your changes to your fork on GitHub:
git push origin feature/my-new-feature
-
-
Create a Pull Request:
- After pushing, go to the original Litterbox repository and create a pull request from your fork. This will allow the project maintainers to review your changes before merging them into the main codebase.
-
Provide Clear Descriptions:
- When creating a pull request, describe what you’ve done, why the changes are needed, and any related issues. This helps the maintainers review your contribution more effectively.
We appreciate your interest in contributing to Litterbox and look forward to your improvements!
If you have any questions or suggestions regarding the Litterbox project, feel free to reach out!
- Project Link: https://github.com/rei-naissance/Litterbox
- Email: [email protected]
We appreciate your interest in Litterbox, and we are happy to assist with any inquiries or contributions!
Thank you for checking out Litterbox!
- OpenAI for providing AI assistance and insights that have been invaluable in the development process.
- Django for powering the back-end of the project with a robust and efficient framework.
- Tailwind CSS for offering a modern, responsive, and highly customizable CSS framework that significantly improved the front-end design.