Sticky-Memo

Sticky-Memo is a sticky notes application built using React.js + Vite along with MUI. This documentation will guide you through the process of contributing to this project.

Table of Contents

• Installation
  • Clone the Repository
  • Frontend Installation
• Project Structure
• Contributing
  • Forking the Repository
  • Cloning the Repository
  • Creating a Branch
  • Making Changes
  • Committing Changes
  • Pushing Changes
  • Creating a Pull Request
• Contributors
• License

Installation

Clone the Repository

1. Fork the repository by clicking the "Fork" button at the top right of the repository page on GitHub.
2. Clone your forked repository to your local machine:

   git clone https://github.com/your-username/Sticky-Memo.git

3. Navigate to the project directory:

   cd Sticky-Memo

Frontend Installation

After cloning the repository:

1. Install the dependencies:

   npm install

2. Start the development server:

   npm run dev

Project Structure

The frontend directory contains the React application.

frontend/
├── public/                 # Public assets
├── src/                    # Source code
│   ├── assets/             # Static assets
│   ├── components/         # Reusable UI components
│   ├── pages/              # Application pages
│   ├── styles/             # Styling files
│   ├── utils/              # Utility functions
│   ├── App.jsx             # Main component that sets up routes
│   └── main.jsx            # Entry point of the React application
├── index.html              # HTML template
├── package.json            # Project metadata and dependencies
└── vite.config.js          # Vite configuration

Contributing

We welcome contributions! To contribute to Sticky-Memo, follow these steps:

Forking the Repository

1. Fork the repository by clicking the "Fork" button at the top right of the repository page on GitHub.

Cloning the Repository

2. Clone your forked repository to your local machine:

   git clone https://github.com/your-username/Sticky-Memo.git

3. Navigate to the project directory:

   cd Sticky-Memo

Creating a Branch

4. Create a new branch for your feature or bug fix (create a branch according to the issue working on):

   git switch -c your-branch-name

Making Changes

5. Make your changes to the codebase. You can edit the files using your preferred code editor.

Committing Changes

6. Add the changes to the staging area:

   git add .

7. Commit the changes with a descriptive message:

   git commit -m "Description of your changes"

Pushing Changes

8. Push the changes to your forked repository:

   git push origin your-branch-name

Creating a Pull Request

9. Create a pull request from your forked repository to the main repository. Go to the "Pull Requests" tab on the main repository, and click "New Pull Request". Follow the instructions to create your pull request.

Contributors

We appreciate the contributions of the following individuals: Contributors

This is just the beginning! I look forward to making more meaningful contributions and collaborating with this amazing community. Let's build something great together and make Sticky-Memo the best it can be! ❤️🤝

License

This project is licensed under the MIT License - see the LICENSE file for details.