Developer Documentation

Table of Contents

• Table of Contents
• Project Objective:
• Setup Project
  • Prerequisites
  • Built With
• Install Project
• Docker Image Deployment Guide
• Developer Documentation
• Contributing
• Team Members

Project Objective:

The goal of this project is to develop a Node.js backend platform serving as a central integration point for various systems. The platform should be capable of creating a GraphQL API enabling comprehensive CRUD operations across integrated systems. Initially, emphasis will be placed on supporting both relational and non-relational databases. The architecture of the platform should be modular and extensible, allowing easy integration of additional services and APIs in the future.

Setup Project

Prerequisites

You need to install or make sure that these tools are pre-installed on your machine:

• NodeJS: JavaScript runtime build.
• Git: Open source version control system.
• Docker: Platform for developing, shipping, and running applications in containers.
• AWS CLI: Command-line interface for Amazon Web Services (AWS).
• NPM or NVM (Node Version Manager): Package manager for Node.js (NPM) is used to install and manage Node.js packages, while NVM allows you to easily switch between different Node.js versions.

Built With

Install Project

1. Clone the Repository

git clone https://github.com/Nessvah/ICARUS

1. Install packages in the root and src/ directory

npm install

3. In the src/ create a .env file and add the jwt secret, the port to run your server, accessKeyId, secretAccessKey, UserPoolId, ClientId and region to configure and using AWS Cognito tools, and privateKeyBackend to decrypting password information which comes from frontend application

JWT_SECRET=secret
PORT=portnumber
accessKeyId=AWSkeyId
secretAccessKey=AWSaccesskey
UserPoolId=AWSuserPoolId
ClientId=AWSclientId
region=AWSregion
privateKeyBackend=----BEGINPRIVATEKEY-----

4. Run the server to start working locally

In the src/ directory run:

npm start

Docker Image Deployment Guide

To deploy your container to AWS ECR and run your API on a EC2, click here to follow the instructions.

Developer Documentation

Check out our dedicated docs page for more technical documentation.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request feature/AmazingFeature) Open a Pull Request

Team Members

• Eliana Delgado
• Pedro Maldonado
• Sílvia Costa
• Susana Silva
• Willian Fischer

Happy Coding ❤️