strvcom / frontend-academy-2022

STRV's Frontend Academy 2022 Repository. See Wiki for lessons content.

Eventio

A project developed during the STRV Frontend Academy 2022. For the Academy lessons, please, check out the Wiki pages.

Built With

• Next.js
• React.js

Getting Started

Follow this section to get the project running on your development machine.

Prerequisites

Before getting started, make sure you have these tools installed:

• Git
• Node.js v18
• Yarn

We recommend you use nvm to install Node.js.

1. Installation

Provided you have all prerequisites ready, you can install the application with the following command:

yarn

2. Environment variables

Setup environment variables:

cp .env.example .env

For the API_KEY, reach out to [e-mail].

3. Start the Application

To start a local server with the running application, run the following:

yarn dev

Deployment

The application is deployed at Vercel everytime new commits are pushed to the main branch (production mode) or to other branches (preview mode).

In case you need to deploy manually, you can install the Vercel CLI and run the following command: vercel

Links

• API Docs - Apiary
• UI Design - Figma

Architecture

Deploys to Vercel will also generate dependency maps, which are made public on the deploy URL on the following paths:

• _dev/architecture/index.html: Full map
• _dev/architecture/2.html: 2 levels deep
• _dev/architecture/3.html: 3 levels deep
• _dev/architecture/4.html: 4 lebels deep
• _dev/architecture/5.html: 5 levels deep

This should not be available in production, but we make it so as a means to have historical evolution of the architecture refactoring.

Contributing

To start contributing to this project:

1. Clone the repository
2. Create a new branch (git checkout -b feature/feature-name)
3. Commit your changes (git commit -m 'feat: add login form')
4. Push to the branch (git push origin feature/feature-name)
5. Open a Pull Request