admin.eclipseexpos.org

Contributing

Prerequisites

• Node.js
• npm
• Docker

Installation

1. Clone the repo

   git clone https://github.com/Eclipse-Expos/admin.eclipseexpos.org.git

2. Install NPM packages

    npm install

3. Run the database container

   docker compose up database -d

4. Run prisma migrations

   npx prisma migrate dev

5. Run the development server

   npm run dev

Note: You will have to create a .env file from the template

Committing

1. Create a new feature branch

   git checkout -b feature/AmazingFeature

2. Commit your changes

    git commit -m 'feat: add some AmazingFeature'

   Remember to use semantic commits

3. Push to the branch

   git push origin feature/AmazingFeature

4. Open a pull request to the dev branch

5. Associate the pull request with the relevant issue (if applicable)