Skip to content

Latest commit

 

History

History
108 lines (76 loc) · 2.22 KB

README.md

File metadata and controls

108 lines (76 loc) · 2.22 KB
Raw

Blog-Project Documentation

Overview

Blog-Project is a web application that allows users to create accounts, log in, write articles, and manage their blog content. The project is built using React (Vite for the build system), Tailwind CSS for styling, and Appwrite as the backend service.

Take a test drive of the application

  • Test Email
[email protected]
  • Test Password
12345678

Features

  1. User Authentication:

    • Users can create accounts and log in securely.

  2. Article Management:

    • Create, update, and delete articles with a user-friendly interface.

  3. React (Vite):

    • Utilizes the React framework for building a dynamic and responsive user interface.

  4. Tailwind CSS:

    • Implements Tailwind CSS for a modern and sleek design.

  5. Appwrite Backend:

    • Backend services are powered by Appwrite, providing secure and scalable user authentication and data storage.

Technologies Used

  • Frontend:

    • React (Vite)
    • Tailwind CSS

  • Backend:

    • Appwrite

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/your-username/Blog-Project.git
cd Blog-Project

  2. Install dependencies:

    npm install

  3. Start the development server:

    npm run dev

    The application should now be running locally.

Project Structure

Blog-Project/
|-- src/
|   |-- components/
|   |-- pages/
|   |-- services/
|   |-- App.jsx
|   |-- index.jsx
|-- public/
|-- .gitignore
|-- package.json
|-- README.md
|-- tailwind.config.js
|-- vite.config.js

Usage

  1. User Registration:

    • Users can register for an account by providing necessary details.

  2. User Authentication:

    • Log in using the registered credentials.

  3. Article Creation:

    • Create new articles by navigating to the "Write Article" section.

  4. Article Management:

    • Edit or delete existing articles through the user dashboard.

Contributing

If you would like to contribute to the project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and submit a pull request.

License

This project is licensed under the MIT License.