Skip to content

A pre-assignment for Reaktor summer 2023 developer internship.

License

Notifications You must be signed in to change notification settings

shchilkin/reaktor-birdnest

Repository files navigation

Reaktor Birdnest

About the project

This monorepo contains apps and packages for creating a fullstack web application, which display information about pilots, who breach no drone area. Done as a pre-assignment for Reaktor 2023 summer internship.

Project Structure

.
├── apps
│   ├── nextjs-app      # Fullstack web application, created with Next.js
│   ├── backend-app     # Backend service, which runs on background and collects drones
│   └── prisma          # Prisma ORM Database Schema
├── packages
│   ├── types           # shared types
│   └── utils           # Shared functions
├── LICENSE
└── README.md

Prerequisites

This project uses Yarn as a package manager. You can install it with Homebrew:

brew install yarn

Installation

  • Clone or download the repo to your local machine
  • Run yarn in the root folder to install dependencies
  • Run yarn prepare to build the project
  • Run build:utils to build the utils and types package

Frontend

  • Run yarn dev:frontend to start the frontend application
  • Open http://localhost:3000 with your browser to see the result.

Backend

  • Run yarn dev:backend to start the backend service

Prisma

This project uses Prisma as an ORM for the database. You can install it with Homebrew:

brew install prisma

or use it with npx:

npx prisma
Generate Prisma client

Run yarn prisma:generate to generate the prisma client

Database credentials

Make sure to provide the correct database credentials in the .env file. Prisma uses DATABASE_URL environment variable to connect to the database.

Limitations

there are some limitations in this project, which are not implemented yet:

  • Add more tests
  • Add Docker support
  • Add CI/CD support
  • Add more documentation

Technology stack

The following technologies and tools are to build this project:

License

Licensed under the MIT License, Copyright © 2022 Aleksandr Shchilkin See LICENSE for more information.