frontend

Application: https://tusk-manager.vercel.app

Getting Started

This project was bootstrapped with Create React App.

In order to use react-scoped-css, this application uses craco instead.

Furthermore, it uses Bulma as the CSS library-of-choice due to its lightweight, customizable and extensible features.

• yarn: Installs the packages
• yarn start: Runs the app in the development mode on http://localhost:3000
• yarn lint: Performs code linting

Setting up your environment

The only environment variable needed is REACT_APP_SERVER_URL. This refers to the url that the application will make API calls to.

• (In .env.production) REACT_APP_SERVER_URL: https://tusk-manager-backend.onrender.com/api
• (In .env.development): REACT_APP_SERVER_URL: http://localhost:8080/api

Directory Structure

• api/: Stores classes that provide an abstraction over outgoing API requests
• assets/: Static asset files, such as the application logo
• components/: Contains components of the application, which are organised based on the atomic web design principle as written in this blog article
• composables/: Contains composable functions that provide data based on reactive arguments
• generated/: Auto-generated type definitions to preserve parity of types with backend code
• store/: Contains redux state and reducers used, created with Redux Toolkit
• utils/: Contains global utility functions

Deployment

Deployment is handled automatically by Vercel when you push your changes to the main branch.