summaryrefslogtreecommitdiff
path: root/README.md
blob: 9241be6ed323343d2067ac7a575ffd08261831a4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# event-me

All the events you never knew you needed to attend!


## Overview

This is a simple full-stack web project for educational purposes, to demonstrate the functionality and value of moving from JS to TS gradually.

It is part of Anjana's course [TypeScript First Steps](https://anjana.dev/typescript-first-steps) on [FrontendMasters](https://frontendmasters.com/teachers/anjana-vakil/).

## Installation

Make sure you have an up-to-date version of [Node](https://nodejs.org/en/download) installed, including [npm]



```
cd backend
npm i 
cd ../frontend
npm i
```

## Running in development

Run the backend and frontend in separate terminals.

1) Run the backend API

Install backend dependencies and launch the dev server:

```
cd backend
npm i
npm run dev
```

The API will be available at `http://localhost:3000/api`.

Leave the backend running in this terminal.

3) Run the frontend client

In a _new_ terminal, install frontend dependencies and launch the dev server:


```
cd frontend
npm i
npm run dev
```

Open the app at `http://localhost:5173`.

Leave the frontend running in this terminal.


## Branches

The [`main`](https://github.com/vakila/event-me/tree/solution) branch contains the starting point for the course exercises, which involve migrating from JS to TS and fixing the app's (intentional) bugs in the process.

The [`solution`](https://github.com/vakila/event-me/tree/solution) branch contains a reference solution for the workshop exercises. But there is more than one way to type a script, so your solution might differ!