ScholarX-Backend

Welcome to the backend of the ScholarX project!

What is ScholarX?

ScholarX is an initiative that aims to provide free premium mentoring assistance to elite undergraduate students based in Sri Lanka. The program connects these students with Sri Lankan expatriates currently involved with some of the world's most renowned universities or Fortune 500 companies. The goal is to establish a sustainable education structure within Sri Lanka by leveraging knowledge and expertise from around the globe.

Contribution

Want to contribute to this project?

We welcome contributions to make ScholarX even better! Feel free to send us a pull request with your changes or improvements. Check out our Development Best Practices at SEF for guidelines.

• Send us a Pull Request

Prerequisites

Before you can start using this project, make sure you have the following installed on your machine:

• Node.js (version 14 or later)
• npm (version 6 or later)

Getting Started

Follow these steps to get started with the ScholarX backend:

1. Clone this repository to your local machine:

   git clone https://github.com/yourusername/scholarx-backend.git

2. Install the dependencies:

   npm install

3. Copy the .env file:

   cp .env.example .env

4. Replace the environment variables in the newly created .env file with your configuration.

5. Start the server:

   npm start

6. Run Tests:

   npm test

7. Open your web browser and navigate to http://localhost:${server_port} to access the running server.

Code Quality

We strive to maintain a high code quality. You can check for linting issues by running:

npm run lint

And to automatically format the code, use:

npm run format

Project Structure

Here's an overview of the project structure:

scholarx-backend/
├── src/
│   ├── controllers/
│   │   └── index.ts
│   ├── middleware/
│   │   └── index.ts
│   ├── routes/
│   │   └── index.ts
│   ├── services/
│   │   └── auth.service.ts
│   ├── entities/
│   │   └── profile.entity.ts
│   ├── index.ts
│   └── types.ts
├── .env.example
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

• src/controllers/: Contains the controller classes that handle incoming requests.
• src/middleware/: Contains the middleware functions used to modify requests and responses.
• src/routes/: Contains the route definitions for the application.
• src/services/: Contains the service definitions for the application.
• src/entities/: Contains the entity models for the application.
• src/index.ts: Creates and configures the Express application and starts the server.
• src/types.ts: Defines custom types for the application.
• .env.example: An example configuration file for environment variables.
• .gitignore: A list of files and directories to be ignored by Git.
• package.json: Contains information about the project and its dependencies.
• tsconfig.json: Configuration file for the TypeScript compiler.

We appreciate your interest in ScholarX. Happy contributing! If you have any questions or need assistance, please don't hesitate to reach out to us.