Before you contribute
To ensure a smooth collaboration, please review these resources before starting your work:
- Read our Contribution Guidelines to understand the project structure and folder rules.
- Search the Existing Issues and open Pull Requests to ensure you are not duplicating work.
Ways to contribute
Bug fixes
Find and fix reproducible problems.
Features
Propose or implement improvements that provide clear value to students.
Content
Improve course, roadmap, project, or student-benefit resources.
Documentation
Improve setup instructions, guides, explanations, and examples.
Design and accessibility
Improve usability, responsiveness, accessibility, and clarity.
Local Development Setup
Prerequisites
Node.js version 18.x or higher, and pnpm version 9.x or higher.
Setup steps
1. Clone the repository:
git clone https://github.com/Mimir-nest/mimir-nest.git
2. Install dependencies:
pnpm install
3. Run the development servers:
To run the Next.js web application (port 3000):
pnpm dev
To run the Express Content API server (port 4000):
pnpm dev:api
4. Build the project:
pnpm build
5. Lint and Typecheck:
pnpm lint pnpm typecheck
Pull requests
- Create a new branch from `main` (e.g. `feature/your-feature`).
- Make focused, modular changes following project boundaries.
- Test your changes locally by running build, lint, and typechecks.
- Update documentation inside the `docs/` folder if necessary.
- Open a pull request targeting the `main` branch.
- Provide a clear description of what was changed and the reasoning behind it.
Good first contributions
If you are new to the repository, you can browse issues tagged with the good first issue label. These issues are curated to have limited scopes and serve as a great introduction to the codebase.
Questions?
If you have any questions about project setup, guidelines, or ideas, feel free to email us directly at:
mimirnest@gmail.com