Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fachryadhitya committed Apr 17, 2022
1 parent 8e18dc5 commit 6dd3367
Showing 1 changed file with 31 additions and 20 deletions.
51 changes: 31 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,45 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
# Trax

## Getting Started
> Royalty-free music web application
First, run the development server:
## Stack used

```bash
npm run dev
# or
yarn dev
```
- [Next.js](https://nextjs.org/)
- [Chakra UI](https://chakra-ui.com/)
- [TypeScript](https://typescriptlang.org/)

## Developing

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
A Node.js LTS setup with [yarn](https://yarnpkg.com/) is recommended.

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
```bash
# install dependencies
yarn install

# serve with hot reload at localhost:3000
yarn dev

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
# build for production
yarn build

The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
# run unit tests
yarn test
```

## Learn More
## Architecture

To learn more about Next.js, take a look at the following resources:
### Data fetching

- [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.
I used [SWR](https://swr.vercel.app/) for the data-fetching logic, allowing for data fetches to be wrapped in a custom hook.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
### State management

## Deploy on Vercel
[React Context](https://reactjs.org/docs/context.html)

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.
### Directory structure

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
- `/components` - UI/layout components that are used globally throughout project.
- `/lib` - Shared utility/helper method.
- `/public` - Next.js public directory, used for storing static assets.
- `/types` - TypeScript types + interfaces that are used globally throughout the project.
- `/prisma` - Prisma migrations and seeder script

0 comments on commit 6dd3367

Please sign in to comment.