Evento

Installation

Required: Node plus npm and Git

1. Fork the repo

   https://github.com/hngx-org/Evento

2. clone the repo

   git clone https://github.com/<your_github_username>/Evento.git

3. Change directory

   cd Evento

4. Set the 'upstream' remote repository to track changes from the original repository

   git remote add upstream https://github.com/hngx-org/Evento.git

5. Pull the latest changes from the 'upstream' remote's 'dev' branch into your local branch

   git pull upstream dev

6. Create a new branch for the task you were assigned to, eg TicketNumber/(Feat/Bug/Fix/Chore)/Ticket-title :

   git checkout -b ZP-B01/Feat/swagger docs

Running Locally

npm install

# Copy env.sample to .env and input your keys

npm run start:dev

Pushing your code

1. Commit your changes with a descriptive commit message, run:

   git commit -m "your commit message"

2. To make sure there are no conflicts, run:

   git pull origin dev

3. Push changes to your new branch, e.g git push origin <your_branch_name> run

   git push -u origin ZP-B01/Feat/swagger docs

4. Create a pull request to the dev branch and not main.

Pull Request Template

## Please follow the guideline when creating a pull request
`<!--- Provide a general summary of your changes in the Title above -->
​
## Description
<!--- Describe your changes in detail -->
​
## Related Issue (Link to linear ticket)
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue : -->
​
## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
​
## How Has This Been Tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
​
## Screenshots (if appropriate - Postman, etc):
​
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
​
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

Folder Structure

Evento/ │ ├── src/ │ ├── controllers/ │ │ ├── greeting.controller.ts │ │ └── ... │ │ │ ├── database/ │ │ ├── greeting.model.ts │ │ └── ... │ │ │ ├── interfaces/ │ │ ├── greeting.route.ts │ │ └── ... │ │ │ ├── middlewares/ │ │ ├── index.ts │ │ └── ... │ │ │ ├── routes/ │ │ ├── database.config.ts │ │ └── ... │ │ │ ├── services/ │ │ ├── greeting.service.ts │ │ └── ... │ │ │ ├── utils/ │ │ ├── helpers.ts │ │ └── ... │ │ │ ├── swagger.ts │ ├── server.ts │ └── ... │ │ ├── .env ├── .gitignore ├── package.json ├── tsconfig.json └── ...

### Here's a brief explanation of each folder:

- `src/`: This folder contains your application's source code.

- - `controllers/`: Controllers handle the business logic of your application.
- - `models/`: Sequelize models represent your database tables.
- - `routes/`: Define your API routes using Express.
- - `middlewares/`: Custom middlewares for authentication, error handling, etc.
- - `configs/`: Configuration files like database configuration.
- - `services/`: Business logic that interfaces with your models.
- - `utils/`: Utility functions that can be reused across your application.
- - `app.ts`: Initialize and configure Express.
- - `server.ts`: Start your Express server.

- `.env`: Store environment variables such as database connection details and API keys.

- `.gitignore`: Ignore files and directories when using Git.

- `package.json`: Node.js project configuration.

- `tsconfig.json`: TypeScript configuration.