-
Notifications
You must be signed in to change notification settings - Fork 3
Technical Installation Manual
The system is built using an Angular frontend and a Spring Boot backend. It leverages the power of Angular for the user interface and Spring Boot to handle server-side processing. UI components are carefully designed using Ionic, while Tailwind CSS adds finesse to our styling needs, creating a visually appealing and intuitive interface. The backend is fortified with Amazon AWS services like Cognito, S3, and DynamoDB, among others, providing a secure and scalable foundation for the system.
Before proceeding with the installation, ensure you have the following software installed:
- Install Node.js from the official website: Node.js Download.
- Install Java from the official Oracle website: Java Download.
To install the system, follow the step-by-step instructions specific to your operating system. Ensure that all prerequisites are met before proceeding with the installation.
Simply download the Repository found at this link: Repo
Ensure that you have Git installed. You may download Git from the official website found at this link: Git.
Subsequently, clone the Repository. This is done by opening the terminal, navigating to the directory where you want to store the project's code. Use the git clone command followed by the repository URL to create a local copy of the repository on your machine. The command should be:
git clone https://github.com/COS301-SE-2023/FridgeToPlate.gitOnce the download is complete, you will have a local copy of the project.
In order to run the application, you will need to have node modules installed. Execute the following command to install all node modules:
npm installThe deployment process is automatically triggered upon merging into the main and dev branches of the project repository. The deployment workflow harnesses the power of GitHub Actions, facilitating efficient releases of new features and updates. The website is hosted on an Amazon S3 bucket, while the backend is served by an EC2 instance. However, it is essential to note that the system can be deployed on any static hosting platform and server-oriented backend, providing flexibility and scalability for future enhancements.
To run the system, execute the following commands in consecutive order:
npm run start:apinpm run start:app:devFor comprehensive guidelines on how to utilize the system to its fullest potential, refer to the user manual.
The system is built using the following versions of software:
- Spring boot (3.0.6)
- Angular (15.9.2)
- Java (17)
- Node (^16)