React theme

Responsive admin template based on Next.js

Getting Started

First Clone the repo by using git clone.

Then Run npm install .

Finally, run the development server using npm run dev.

Open http://localhost:3005 with your browser to see the result.

Built With

Next.js 
Typescript
Material-ui
i18next
StoryBook
Jest
Cypress

project structure

pages                              # App pages
│   _app.tsx                       # App entry point
│   _document.tsx                
│   index.tsx                      # App home page
│   calendar.tsx                   # App calendar page
src 
└───api                            # Api calls
└───components                     # App components 
        └───elements               # App basic blocks
        └───layouts                # App different layout 
        └───modules                # App modules
        └───templates              # App page templates
└───constants                      # App custom constants 
└───context                        # App custom contexts 
└───hooks                          # App custom hooks
└───mocks                          # App mocks
└───styles                         # App styles
└───types                          # App custom types
└───utils                          # App utils

Running Dev Server

Run on your terminal npm run dev, the server will restart everytime we make a change in our code.

Building APP for Production

run npm run build

Running StoryBook

run npm run storybook

Running tests

run npm run test

Other scripts

Versioning

For the versions available, see the tags on this repository.

Authors

Amell Fezai - Initial work

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Some helpful links used for this work

Next.js project structure [https://wityan.medium.com/next-js-project-structure-1531610bed71]

Git branches and commits best practises [https://www.codeheroes.fr/2020/06/29/git-comment-nommer-ses-branches-et-ses-commits/]