README.md

Tutorial Website

Welcome to our Tutorial Website project! This project aims to create a platform where users can share tutorials on various topics, such as programming, cooking, DIY projects, and more. Users can sign up, log in, submit tutorials, and view tutorials submitted by others. Additionally, users can upload their tutorials in Markdown format, making it easy to format and style their content.

Project Overview

The Tutorial Website project is a dynamic web application developed as part of our web development course final project. It fulfills the requirements outlined by our instructor and provides a user-friendly platform for sharing and accessing tutorials.

Tech Stack

Features

• User Authentication: Users can sign up and log in to the website.
• Tutorial Submission: Logged-in users can submit tutorials, including images or videos, and a description.
• Tutorial Viewing: Users can view tutorials submitted by other users.
• CRUD Operations: Users can create tutorials, view tutorials, and delete their tutorials.
• Security Measures: Basic security measures are implemented to protect user data and prevent unauthorized access to tutorial editing or deletion.

Requirements

The Tutorial Website project fulfills the following requirements:

1. • Page Count and Content:
   • The website contains multiple pages, including login/signup, tutorial submission, and tutorial viewing pages.
2. • Frontend Development:
   • Developed using HTML, CSS, and JavaScript to ensure a cohesive visual appearance.
3. • Backend Development:
   • Backend functionality is implemented using Node.js to handle user authentication and tutorial submission.
4. • Database Integration:
   • MongoDB is used as the database to store user information and tutorials.
5. • CRUD Operations Support:
   • Users can create, read, and delete tutorials. Editing tutorials is restricted to the tutorial owner.
6. • Security Measures:
   • Basic security measures are implemented, including user authentication, to protect user data.
7. • Navigation and Organization:
   • The website has a clear menu structure and intuitive navigation elements.
8. • Readability and Accessibility:
   • Text readability, high contrast, and appropriate font sizes are ensured for optimal accessibility.
9. • Multimedia Content:
   • Users can upload images or videos as part of their tutorial submissions.
10. • Responsive Design:
    • The responsive website provides a seamless user experience across various devices.

Screenshots

Getting Started

To get started with the Tutorial Website project, follow these steps:

1. Clone the repository to your local machine.
2. Install dependencies using npm install.
3. Then run this code:

   cd backend
   npm run dev

4. Set up a MongoDB database and update the config/dbConfig.js file with your database configuration.
5. Set up a .env file and add your data.
6. Access the website locally in your browser.

Contributing

We welcome contributions to the Tutorial Website project! If you'd like to contribute, please fork the repository, make your changes, and submit a pull request. Make sure to follow our contributing guidelines.

Our Contributors ❤️

Thank you for contributing to our repository!

Our Contributors ❤️

Thank you for contributing to our repository

Show some ❤️ by starring this awesome repository!

License

The Tutorial Website project is licensed under the MIT License.