The Sinnples is a Next.js application that allows users in an apartment complex to recommend services to each other. Users can view a list of recommended services, add new recommendations, edit existing recommendations, and delete recommendations.
The purpose of this app is to provide a centralized platform for residents in an apartment complex to share and discover recommended services. It promotes community engagement and helps residents find trusted service providers based on personal recommendations.
To run the Sinnples App locally, follow these steps:
- Clone the repository:
git clone git@github.com:daniloab/sinnples.git- Install dependencies:
cd sinnples
yarn install - Set up the MongoDB database:
- Configure your MongoDB connection details in the
.envfile. - Make sure MongoDB is running on your local machine or update the connection URL accordingly.
- Start the development server:
yarn dev- Open your browser and access the app at
http://localhost:3000.
Contributions to the Sinnples are welcome. To ensure a smooth collaboration, please follow these minimal contribution rules:
-
Fork the repository and create a new branch for your changes.
-
Commit your changes with clear and descriptive commit messages.
-
Write clear and concise code, following the project's code style and conventions.
-
Include appropriate test cases for any new features or bug fixes.
-
Document any significant changes or new features in the project's documentation.
-
Submit a pull request to the main repository and provide a detailed description of your changes.
-
Be responsive to feedback and be willing to make necessary changes based on code reviews.
-
Respect the project's code of conduct and maintain a positive and inclusive environment.
The Service Guru is licensed under the MIT License.