update,
This commit is contained in:
58
vinniesniper-54816/task1/project/frontend/README.md
Normal file
58
vinniesniper-54816/task1/project/frontend/README.md
Normal file
@@ -0,0 +1,58 @@
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
|
||||
A JavaScript starter for Next.js that includes all you need to build your next 🦄 project.
|
||||
|
||||
## Technologies Used
|
||||
|
||||
- [Nextjs](https://nextjs.org/)
|
||||
- [Material UI](https://mui.com/)
|
||||
- [Eslint](https://eslint.org/)
|
||||
- [Prettier](https://prettier.io/)
|
||||
- [Husky](https://typicode.github.io/husky/#/)
|
||||
|
||||
Also includes:
|
||||
|
||||
- [Absolute imports](https://nextjs.org/docs/advanced-features/module-path-aliases)
|
||||
- [AirBnB Style Guides for React](https://github.com/airbnb/javascript/tree/master/react)
|
||||
|
||||
# Getting started
|
||||
|
||||
```
|
||||
1. git clone https://github.com/miami78/nextjs-mui-boilerplate
|
||||
|
||||
2. cd nextjs-mui-boilerplate
|
||||
|
||||
3. yarn && yarn dev or npm install && npm run dev if you prefer not to use yarn.
|
||||
|
||||
```
|
||||
|
||||
# Usage
|
||||
|
||||
### Development server
|
||||
|
||||
```bash
|
||||
yarn start / npm start
|
||||
```
|
||||
|
||||
You can view the development server at `localhost:3000`.
|
||||
|
||||
### Production build
|
||||
|
||||
```bash
|
||||
yarn build / npm run build
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork this repository;
|
||||
2. Create your branch: ``git checkout -b my-new-feature``
|
||||
3. Commit your changes: ``git commit -m 'Add some feature'``
|
||||
4. Push to the branch: ``git push origin my-new-feature``
|
||||
|
||||
|
||||
Made by [Larry Miami](https://github.com/miami78)
|
Reference in New Issue
Block a user