56 lines
2 KiB
Markdown
56 lines
2 KiB
Markdown
# XAM Login and Dashboard Page</br>
|
|
|
|
Developed by Luis Carlos Tan for XAM Senior React JS Developer Assessment Test. Created using [Blazity/next-enterprise](https://github.com/Blazity/next-enterprise) boilerplate.
|
|
|
|
## Features
|
|
|
|
With this template, you get all the awesomeness you need:
|
|
|
|
- 🏎️ **[Next.js](https://nextjs.org/)** - Fast by default, with config optimized for performance (with **App Directory**)
|
|
- ✨ **[ESlint](https://eslint.org/)** and **[Prettier](https://prettier.io/)** - For clean, consistent, and error-free code
|
|
- 🛠️ **[Extremely strict TypeScript](https://www.typescriptlang.org/)** - With [`ts-reset`](https://github.com/total-typescript/ts-reset) library for ultimate type safety
|
|
- **[Bundle analyzer plugin](https://www.npmjs.com/package/@next/bundle-analyzer)** - Keep an eye on your bundle size
|
|
- **[Jest](https://jestjs.io/)** and **[React Testing Library](https://testing-library.com/react)** - For rock-solid unit and integration tests
|
|
- **[Absolute imports](https://nextjs.org/docs/advanced-features/module-path-aliases)** - No more spaghetti imports
|
|
- **[Yarn](https://yarnpkg.com/)** - A package manager and project manager as well
|
|
- **[Redux](https://redux.js.org/)** - State management package for JS Apps
|
|
- **[Material UI](https://mui.com/)** - Intuitive and responsive package offering comprehensive suite of UI Tools
|
|
|
|
## 🎯 Getting Started
|
|
|
|
To get started with this boilerplate, follow these steps:
|
|
|
|
1. Fork & clone repository:
|
|
|
|
```bash
|
|
git clone https://github.com/<your_username)/Xam-Login-Form.git
|
|
```
|
|
|
|
2. Install the dependencies:
|
|
|
|
```bash
|
|
yarn install --frozen-lockfile
|
|
```
|
|
|
|
3. Run the development server:
|
|
|
|
```bash
|
|
yarn dev
|
|
```
|
|
|
|
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
|
|
|
5. (Optional) Run the production mode server:
|
|
|
|
```bash
|
|
yarn build
|
|
yarn start
|
|
```
|
|
|
|
|
|
|
|
## 🧪 Testing
|
|
|
|
### Running Tests
|
|
|
|
- **Unit and integration tests**: Run Jest tests using `yarn test`. Use `yarn test:watch` for a smoother development experience.
|