contributions.md

Contributing to api-docucraft

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

• Star the project
• Tweet about it
• Refer this project in your project's readme
• Mention the project at local meetups and tell your friends/colleagues

I Have a Question

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

• Open an Issue.
• Provide as much context as you can about what you're running into.
• Provide project and platform versions (Node.js, npm, etc.), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Setting Up the Development Environment

To contribute to the project, follow these steps to set up the development environment for both the client and server applications:

Client (Vite - React) App

1. Navigate to the client folder:

   cd client

2. Install dependencies:

   # Install client dependencies
   npm install

3. If react-scripts are not installed:

   npm install react-scripts --save

4. If vite is not installed:

   npm i vite
   npm install --legacy-peer-deps

5. Run the Vite development server:

   npm run dev

6. Open your browser: Open your browser and navigate to http://localhost:3000 to see the client app.

Now you're all set to start contributing to the project!