Web

Frontend application for fictadvisor.com
Explore the docs »

View the Website · Report a Bug · Request a Feature

Table of contents

1. About the project
   • Built with
2. Getting started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About the project

This application renders and serves frontend for the FICT Advisor. Some components of the application are rendered using SSR.

Built with

• Next.js
• Material UI
• SASS
• Storybook
• EsLint

Getting started

To get a local copy up and running follow these steps.

Prerequisites

• fictadvisor-api (see instructions here)
• yarn npm i -g yarn

Installation

1. Clone the repository

   git clone https://github.com/fictadvisor/fictadvisor-web.git

2. Install NPM packages

   yarn install

Usage

To start the application locally:

yarn dev

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Feedback - https://t.me/fict_robot

Project - https://github.com/fictadvisor