eyalhadad/mlfrontend

Micro - Message RNA interactions, Frontend side

Table of Contents

• Installation
• Scripts
• Project Structure
• Deployment and availability

Installation

Prerequisite:

• Git
• Node.js package manager (NPM)

Once you clone the project, run the npm install command to install the npm packages the project uses.

You will have to add a local .env file with the project dependencies.

git clone

npm start

Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Project Structure

• .github - contains CICD files used by github actions
• public - contains files generated by the [`npm build`] command
• src - containse the source code of the project
  • api - contains api requests and objects
  • classes - contains reused classes throughout the code
  • components - all the componets that are reused throughtout the code
  • extensions - images, gifs, videos etc.
  • pages - the main pages in the web site, navigated through navbar
• package.json
• package-lock.json
• README.md
• .gitignore
• Dockerfile

Deployment and Availability

The deployment of this project is continuous and made throught the github actions CICD native provider.
The configuration is located in the .github directory, and configured to deploy on push, to the deploy branch.
The pipeline will test, build and verify the app berfore the deployment is made.

The website is up and running, and available at http://132.73.84.177/