InstaQuiz
Github
  • Introduction
  • Setup
    • Requirements
    • Environment setup
    • Testing
  • Database
    • Schema
    • Setup
  • Server
    • Folder structure
    • Code structure
    • API Reference
  • Client
    • Folder structure
    • Code structure
  • deployment
    • Your own server
    • Fly.io
Powered by GitBook
On this page
  • Git and Github
  • Node
  • PNPM
  • Database
  • IDE
  1. Setup

Requirements

PreviousIntroductionNextEnvironment setup

Last updated 1 year ago

To be able to run the application and develop it in your local environment you need tools below installed.

Git and Github

For cloning and managing versioning of the application you need to have git installed on your system.

You can follow instructions on this page to get started with git:

Also an account on Github, sign up at:

Node

You can install node from:

and you can follow these instructions for installing it:

PNPM

pnpm was used for managing node packages in the project.

Installation on Windows:

iwr https://get.pnpm.io/install.ps1 -useb | iex

Installation on Mac and Linux:

curl -fsSL https://get.pnpm.io/install.sh | sh -

For more information on installing pnpm go to:

Database

IDE

Postgresql was used for the database of the project, you're free to use any database provider or setup your own server. I used the free tier of as it is a good fit for the project usage.

You can sign up at

Creating the database documentation:

You can use or any ide you like for the development of this application.

https://github.com/git-guides/install-git
https://github.com/signup
https://nodejs.org/en/download
https://nodejs.dev/en/learn/how-to-install-nodejs/
https://pnpm.io/installation
Neon
https://console.neon.tech
https://neon.tech/docs/get-started-with-neon/setting-up-a-project
VSCode