Skip to content

Latest commit

 

History

History
108 lines (81 loc) · 3.52 KB

README.md

File metadata and controls

108 lines (81 loc) · 3.52 KB

GrowItRapid

Frontend Website Template for GrowItRapid

Welcome to the Frontend Website Template repository for GrowITRapid. This template is designed to kickstart development of this projects with ease. Below, you'll find all the information you need to get started.

Key Features

  • Responsive Design: Ensure the website looks great on all devices, from desktops to mobiles.
  • Modern Frameworks: Built with the latest web technologies and frameworks to ensure high performance and maintainability.
  • Customizable Styles: Easily modify the template's styles to match the brand's look and feel.
  • Optimized Performance: Prioritized performance optimization for a seamless user experience.
  • Reusable Components: Includes a library of reusable components to speed up development.
  • Documentation: Detailed documentation to guide through every aspect of the template.

Installation

  1. Clone the repository:
git clone https://github.com/growitrapid/site-main-template
  1. Navigate to the project folder:
cd site-main-template
  1. Install dependencies:
npm install
  1. Rename the .env.example file to .env and update the environment variables:
  2. Setup the database: (This will also add some mock data in the database):
$env:MONGODB_URI="mongodb+srv://<username>:<password>@cluster0.bpoiuyt.mongodb.net/?retryWrites=true&w=majority"

npm run setup-db
  1. Start the development server:
npm run dev

Contributing

We welcome contributions from the community. If you'd like to improve this template, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature
  3. Make your changes and commit them: 
    git commit -m 'Added a new feature'
  4. Push to your fork and submit a pull request. 
    git push origin feature/your-feature

We'll review your contribution as soon as possible.

Rules and Guidelines

Please make sure to follow these rules and guidelines when contributing to this project:

  1. Make sure your code is well documented, commented & well tested.
  2. Make sure your code follows the project's coding style.
  3. Ensure the website's layout is responsive and looks great on all devices.
  4. Mentain the brand's look and feel when modifying the template's styles.
  5. This project uses the server actions & all function are located in the /src/functions folder. Don't make any changes in that directory. If you feel the necessity for any changes, inform us. We will update it, if necessary.
  6. Don't touch the /src/app/api/auth/[...nextauth] directory.

License

This project is licensed under the MIT License. For more details, please see the LICENSE file.