README.md

🍋 Clean Energy Access 🍋

The purpose of this API is the capture and filtering of leads and the verification of the eligibility of customers and companies that wish to carry out the acquisition of our clean energy and CO2 reduction program.

   

🔨 Technology

The main tools used in the project:

• Typescript
• Serverless
• Node.js
• Middy
• Zod
• AWS

  

🗂️ Project Directories Structure

.
├── docs                # Files generated by OpenAPI for API documentation
├── infra               # AWS infrastructure configuration files used by SLS
│   ├── functions.yml   # Lambda function definitions
│   ├── iamroles.yml    # Policies and actions of IAM roles
│   └── resources       # Other AWS infrastructure resources
├── src                 # Project source code
│   ├── common          # Common code shared across the project
│   └── functions       # Source code for Lambda functions
├── tests               # Unit testing with Jest
└── serverless.yml      # Infrastructure configuration main file

  

🚀 How to run the project

# clone repository
git clone git@github.com:fernandobritto/clean-energy-access.git

# enter the project folder
cd clean-energy-access

# install dependencies
yarn install

# run the project
yarn localhost

   

Author

Fernando Britto

https://br.linkedin.com/in/fernando-britto