xonecas.io
4436
Sl

sesame-labs-coding-assignment / commit fd59e35

Adds better instructions

- Also did a self code review.

Sean2023-01-16 fd59e358149180e481ba4160f4d4e3566f1cb7e2 parent 6390e09

2 files changed

README.md+26−9
@@ -1,5 +1,31 @@
11 # Sesame Coding Assignment
22
3+### Setting up this project:
4+
5+Project was built using the Node stable release at the moment (v16.17.0), please make sure you have a compatible node version. If you use nvm then you can use the command: `nvm use` and it should pick up the `.nvmrc` file included in this repo.
6+
7+**Installing**
8+
9+1. Copy the file [./api/.env.sample](./api/.env.sample) to a new file called `.env` in the same location. Then edit the file to include the required credentials and IDs.
10+
11+ Note: To get the IDs you will need to have your discord client in developer mode to access the data.
12+
13+1. At the api folder: `npm i`.
14+1. At the UI folder: `npm i`
15+
16+**Running**
17+
18+1. To start the api server, type this command in the `api` folder: `npx tsc && node dist/`
19+1. To start the ui server, type this command in the `ui` folder: `npm start`
20+
21+ Note: Using the create react app dev server for convenience, in a production environment i'd use nginx or similar to serve the build folder.
22+
23+1. You should have a new browser tab pointing to `http://localhost:3000/`, if not please open this URL with your browser.
24+
25+Note: If you'd like to wipe the db and redo the product flow, please use this command in the `api` folder: `npx prisma migrate reset`
26+
27+---
28+
329 ### Build a Discord Questing Platform
430
531 Welcome to Sesame’s coding challenge, in which you will build a Questing Platform ([https://bit.ly/sesame-coding](https://bit.ly/sesame-coding)) that rewards people with coupon codes for joining a Discord server.
@@ -24,12 +50,3 @@ Welcome to Sesame’s coding challenge, in which you will build a Questing Platf
2450 - This will be followed by a 45 min interview where you will be asked to explain your decisions and asked to describe about challenges and opportunities with your solution
2551 - In addition to correctness, we will be evaluating based on code structure, readability, and extensibility. It does not need to be over-engineered, however should be solid production level code.
2652 - Please reach out if you have any questions.
27-
28-**Running this project:**
29-
30-Project was built using the Node stable release at the moment (v16.17.0), please make sure you have a compatible node version. If you use nvm then you can use the command: `nvm use` and it should pick up the `.nvmrc` file included in this repo.
31-
32-1. To start the api server, type this command in the `api` folder: `node dist/index.js`
33-1. To start the ui server, type this command in the `ui` folder: `npm start`
34- Note: Using the create react app dev server for convenience, in a production environment i'd use nginx or similar to serve the build folder.
35-1. Head to `http://localhost:3000/` with your favorite browser.
api/prisma/dev.db+0−0
Binary file, not shown.