Skip to content

Alexandrshy/Dev-Guidance

Repository files navigation

DevGuid

A platform for learning frontend development by participating in real projects. Join small groups of up to 5 people and work on projects together. Get hands-on experience, improve your skills, and collaborate with others in a group development or pair programming format.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them. This usually includes Node.js and npm.

Installing

A step-by-step series of examples that tell you how to get a development environment running:

  1. Clone the repository: git clone https://github.com/Alexandrshy/Dev-Guidance.git
  2. Navigate to the project directory: cd Dev-Guidance
  3. Install dependencies: npm install
  4. Run the development server: npm run dev Now you should be able to open the project at http://localhost:3000.

Contributing

Proposing a Change

  1. Clone the repository and create a new branch: git checkout -b my-branch-name.
  2. Make your change, add tests, and ensure the tests pass.
  3. Commit your changes: git commit -am 'Add some feature'.
  4. Push to the branch: git push origin my-branch-name.
  5. Submit a Pull Request through GitHub.

Creating a New Project

  1. Create a new markdown file in the _projects directory.
  2. Write the description of your project using Markdown.
  3. Commit and push your changes.
  4. Create a Pull Request. For a more detailed guide, please refer to the GitHub Pull Request documentation.

Running the Tests

Explain how to run the automated tests for this system:

npm run test

  • Built With
  • Next.js
  • TypeScript
  • Jest
  • Other technologies...

License

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

Acknowledgments

Thank you to all contributors and anyone who has helped to improve this project.