README.md

Stichting Ik Wil App by De Sigaar

Table of Contents

• About
• Prerequisites
• Installation
  • Clone
  • Setup
  • Running
• Built with
  • Techniques
  • Packages
• Contributors

About

This project was made by some students from the Fontys Hogeschool ICT on behalf of 'Stichting Ik Wil'. A live preview can be found on our deployed firebase app.

Prerequisites

• Node.js

Installation

Make sure you have Node.js installed. If you are unsure if node is installed, run $ node -v within a terminal.

Clone

Clone this repository to your local machine and move to the new folder.

$ git clone https://github.com/DeSigaar/ikwil-app.git
$ cd ikwil-app

Setup

Install all needed node modules.

$ npm install

Create an enviroment variables file named .env in the root of the folder with the following variables:

REACT_APP_firebase_apiKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
REACT_APP_firebase_appId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
REACT_APP_firebase_authDomain=xxxxxxxxxx.firebaseapp.com
REACT_APP_firebase_databaseURL=https://xxxxxxxxxx.firebaseio.com
REACT_APP_firebase_measurementId=xxxxxxxxxxxx
REACT_APP_firebase_messagingSenderId=xxxxxxxxxxx
REACT_APP_firebase_projectId=xxxxxxxxxx
REACT_APP_firebase_storageBucket=xxxxxxxxxx.appspot.com
REACT_APP_firebase_vapid_public=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Running

Start the application on port 3000.

$ npm start

Built with

Techniques

• TypeScript
• React
• Redux
• Firebase
• Styled Components
• Jest

Packages

• React Redux Firebase
• Redux Firestore
• Redux Thunk
• React Router
• Connected React Router

Contributors

• Max Altena
• Dylano Hartman
• Noël Herwig
• Timo van de Laar

See the whole list of contributors who participated in this project.