In order to set up the project, you need to have NodeJS (version 18 or higher) installed.
-
Clone the repository and open the directory
> git clone https://github.com/Foacs/cars-be.git > cd cars-be
-
Install the dependencies with PNPM
cars-be> pnpm install -
Build the project
cars-be> ENV_NODE=dev npx webpack --mode=development
|
Note
|
A
|
- NodeJS
-
Version: `18.x`
- PNPM
-
Version: `8.x`
- Webpack
-
Version: `5.x`
- AWS SDK for JavaScript v3
-
Version: `3.x`
The project is divided into several folders inside :
- endpoints
-
Contains the endpoints' implementations. These codes are deployed to AWS Lambda.
- mappings
-
Contains mapping, used to map REST request into Lambda input and Lambda output into REST response.
- models
-
Contains REST input/output models.
- infrastructure
-
Contains Cloudformation templates used to deploy infrastructure onto AWS.
For detailed information about contributing, check the guide.
This project is licensed under the terms of the CeCILL license version 2.1.
|
Note
|
You can check the full license here. |
