Skip to content

Slightly-Techie/crm-web

Repository files navigation

Slightly Techie CRM

Getting Started

First, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Contribution Guidelines

Thank you for considering contributing to our project! We welcome any contributions that can help improve the project and make it even better. By contributing, you agree to abide by the following guidelines.

How to Contribute

  1. Clone the project to your local machine.
  2. Create a new branch with a descriptive name for your feature or bug fix:
git checkout -b <your-initials>/<feature-or-issue>
  1. Make the necessary changes and ensure that the code passes any existing tests.
  2. Commit your changes with a clear and descriptive commit message:
git commit -m "add: homepage with rizz"
  1. Push your branch to the repository on GitHub:
git push -u origin <name-of-branch>
  1. Open a pull request in the original repository, providing a detailed description of your changes and any relevant information.

ps: please try building the project on your local machine to confirm everything works before pushing...Thanks🙃

Code Style and Guidelines

We'll try and create a more structured code style and guideline document later, but for now read how the existing code is architeched and try to follow along.

  • Follow the existing code style and guidelines used in the project.
  • Ensure that your code is well-documented and easy to understand.
  • Write clear commit messages that describe the purpose of your changes.