-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Relates #2
- Loading branch information
Showing
1 changed file
with
50 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,55 @@ | ||
## The Norm Tech for Better Project | ||
# The Norm 🧠 | ||
|
||
First, run the development server: | ||
#### The Norm Frontend, developed as a part of Founders and Coders Tech for Better Program. | ||
|
||
```bash | ||
![TypeScript](https://img.shields.io/badge/TypeScript-blue) | ||
![Node.js](https://img.shields.io/badge/TS--Node-blue) | ||
![Tailwind](https://img.shields.io/badge/Tailwind-blue) | ||
![Next.js](https://img.shields.io/badge/JS--Next-blue) | ||
![Shadcn UI](https://img.shields.io/badge/ShadcnUI-blue) | ||
![License](https://img.shields.io/badge/License-MIT-blue) | ||
|
||
## Table of Contents | ||
|
||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [API Endpoints](#api-endpoints) | ||
- [DB Diagram](#db-diagram) | ||
<!-- - [Testing](#testing) | ||
- [Contributing](#contributing) | ||
- [License](#license) --> | ||
|
||
## Installation | ||
|
||
1. **Clone the repository:** | ||
|
||
```sh | ||
git clone | ||
cd thenorm | ||
``` | ||
|
||
2. **Install dependencies:** | ||
|
||
```sh | ||
npm install | ||
``` | ||
|
||
<!-- 3. **Set up environment variables:** | ||
|
||
Create a `.env` file in the root directory and add your configuration settings. | ||
|
||
```env | ||
``` --> | ||
|
||
## Usage | ||
|
||
### Running the Server | ||
|
||
To start the server, use the following command: | ||
|
||
```sh | ||
npm run dev | ||
# or | ||
yarn dev | ||
# or | ||
pnpm dev | ||
# or | ||
bun dev | ||
``` | ||
|
||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
|
||
## Learn More | ||
<!-- The server will run on the port specified in the `.env` file. If no port is specified, it will default to `3000`. --> |