👨‍💻 Simple Retro

🔥 | Running the project

To run Simple Retro, you need to have Node.js in your machine. We recommend the usage of the Yarn package manager, so the instalation follows the yarn.lock lockfile.

🧹 Clone the repository

git clone git@github.com:simple-retro/frontend.git

💻 Installing the dependencies

yarn install

🔑 Preparing the enviroment

When building the application, the environment variables defined in the .env file will be used to replace all envs with their value in the bundled JavaScript files.

cp .env.example .env

Replace all variables with the values that suit your need.

🏃‍♂️ Running

yarn dev --host

Now, access the address in your terminal 🔥

📦 Buiding for production

To deploy the Simple Retro, bundle all files with the following command:

yarn build

All files will be available in the dist folder. When deploying, you need to return the index.html file to all requests that dont fit any existing files.

🔨 | Made With

⚖️ | License

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