27 lines
757 B
Markdown
27 lines
757 B
Markdown
This is a social media app written in [Next.js](https://nextjs.org). It's currently in a bare bones state and is far from complete.
|
|
|
|
## App architecture
|
|
|
|
- Uses mySQL as database
|
|
- uses NextJS as full stack framework
|
|
- uses Biome as linter
|
|
- uses prismaORM to allow typescript to interact with DB
|
|
- uses react as frontend
|
|
- uses Clerk to handle user authentication
|
|
- uses Uploadthing to handle image storage
|
|
|
|
## Getting Started
|
|
|
|
To start the application, first, start the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
|
|
npm run start
|
|
```
|
|
|
|
> [!IMPORTANT]
|
|
> You will need to create an env file and setup API keys with Clerk and Uploadthing for the application to work propperly
|
|
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) with your browser to see the app |