From f1ea737e610be9f35def9968d0f9e48ad12241f0 Mon Sep 17 00:00:00 2001 From: jamesratcliffe101 Date: Fri, 3 Apr 2026 19:01:47 +0100 Subject: [PATCH] updated readme --- README.md | 43 +++++++++++++++++-------------------------- 1 file changed, 17 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index e215bc4..e204ad2 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,27 @@ -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). +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 -First, run the development server: +To start the application, first, start the development server: ```bash npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev + +npm run start ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +> [!IMPORTANT] +> You will need to create an env file and setup API keys with Clerk and Uploadthing for the application to work propperly -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. +Open [http://localhost:3000](http://localhost:3000) with your browser to see the app \ No newline at end of file