feat: UI redesign (#18)

Author: ft-ally

.gitignore

@@ -1,8 +1,9 @@
+CONTRIBUTE.md
 .env
 build/*
 dist/*
 node_modules/*
-database/*
+database
 *.db
 *.db-journal
 */.DS_Store

README.md

@@ -1,22 +1,47 @@
+<p align="center">
+  <img src="static/images/logo-dark.svg" alt="CodamHero Logo" width="500"/>
+</p>
+
 # CodamHero v2
 CodamHero v2 gives staff and students an overview of everything Codam.
 
 ## Limited access
 Only staff members or C.A.T.s have access to (parts of) piscine overviews by design.
 
-## Development
-To get started, run the folllowing:
+## Prerequisites
+- Node.js (`brew install node` if you are on Mac, otherwise you gotta figure it out)
+- A 42 API key (get one from your intra: Settings > Applications > Register a new app)
+	- URI key must be localhost:4000 or 5000 according to your build
+	- Make sure the scope is accurate
+
+## Setup
+**Install dependencies:**
 ```bash
-docker compose up -d # for the PostgresQL database
+docker compose up -d # for the PostgreSQL database
 npm install
-npm run build
+```
+
+**Setup your keys:**
+```bash
 cp .env.example .env
 nano .env
+```
+- Add your INTRA_UID and INTRA_SECRET
+- Add a SESSION_SECRET and DIRECT_AUTH_SECRET
+
+
+## Development
+**Run the following:**
+```bash
+npm run build
 npx prisma migrate deploy
 npm run start
 ```
 
-To migrate the database, run:
+**To migrate the database, run:**
 ```bash
 npx prisma migrate dev --name "<migration-name>"
 ```
+
+### Notes
+**Don't push your API key.**