README.md

FORTUNA FLOW - WEB

Front-end of fortuna-flow.

Table of Contents

• FORTUNA FLOW - WEB
  • Table of Contents
  • Requirements
  • Installation
  • Usage
  • Building
  • Contributing

Requirements

• Node JS v20.10.0
• NPM v10.2.3

Installation

Steps to install this project.

1. Clone this repository

   git clone https://github.com/Shiyinq/fortuna-flow.git

2. Navigate to the project directory:

   cd fortuna-flow/frontend

3. Install dependencies:

   npm install

4. Make .env file

   cp .env.example .env

Usage

Once you've clone a repository and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

NOTE: Please ensure that you run the backend API first. You can find instructions in the README file.

Building

To create a production version of your app:

npm run build

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Contributing

• You can open issues to report bugs or request features.
• You can fix bugs and add features on your own.
  1. Fork this repository
  2. Create a feature branch git checkout -b new-feature
  3. Commit your changes git commit -m 'Add new feature'
  4. Push to the branch git push origin new-feature
  5. Create a Pull Request