Skip to content

Development

Jump to bottom
Zasaimster edited this page Dec 8, 2023 · 5 revisions

Local Development

In order to work on ByteSize Insights locally, be sure to check the information on our project's README.

There is a section that discusses the necessary information for installing the service. Additionally, there are documented instructions for developing the frontend, backend, and lambda function.

Deploying the Application on Vercel

The Next.js frontend is deployed on Vercel. The following steps can be followed to deploy it:

  1. Create an account at https://vercel.com/
  2. Create a new project. Give it a relevant title like "bytesize-insights-frontend"
  3. Select "Import Git Repository" and select GitHub. This will prompt you to sign in with your GitHub account and grant permissions to Vercel in your repository.
  4. Once Vercel has permissions to your GitHub account, select this repository. You may need to fork this repository so that Vercel can access a version of it on your GitHub account.
  5. Under "Framework Preset" select "Next.js". Set the root directory to frontend/byte-size
  6. The default build and output settings can be used. Click deploy and view your hosted frontend! Here is an example of what the deployed frontend should look like.

The FastAPI backend is also deployed on Vercel. The following steps can be followed to deploy it:

  1. Navigate to you Vercel account and create a new project. Give it a relevant title like "bytesize-insights-backend"
  2. Your GitHub account should already be linked to Vercel. Select this repository from the list of repositories.
  3. Under "Framework Preset" select "Other". Set the root directory to backend/
  4. Configure the build settings to run python main.py. Click deploy and try out your hosted backend API!

Clone this wiki locally