Skip to content

Commit 825d7de

Browse files
authored
Update README.md
1 parent 11dabce commit 825d7de

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,30 @@
11
# Online Marketplace App
22

3-
![homepage](./docs/homepage.png)
4-
53
## Overview
64

7-
This project was setup using create-t3-app, and uses all the optional settings except for next-auth. Instead, it uses https://clerk.com/ to authenticate users.
5+
Online store for selling digital products (Software applications related to artifficial intelligence). Users can list their own apps or make offers for other listings. It currently does not handle payments.
6+
7+
For authentication, this app uses Clerk, a solution that provides out of the box user management.
8+
The database is a PostgreSQL that runs in a Docker container, by running a local script. The NextJS app uses Prisma ORM to communicate with the PostgreSQL database.
89

910
## How to Run
1011

12+
First, run ``` ./run-docker.sh ``` to start the Docker container for the database.
13+
14+
The, set up an account on Clerk.com, create a new project and copy the API keys. Follow the .env.example file to construct a .env file.
15+
16+
To run the NextJS app, run the following:
17+
18+
### with npm
19+
1120
1. `npm i`
1221
2. `npx prisma db push`
1322
3. `npm run dev`
23+
24+
### with pnpm
25+
26+
1. `pnpm i`
27+
2. `npx prisma db push`
28+
3. `pnpm run dev`
29+
30+
This will migrate the changes to the database and start the NextJS server on http://localhost:3000.

0 commit comments

Comments
 (0)