A Frontend microservice platform for a comprehensive data management of intersex and trans-persons in Zambia.
ITEZ Frontend stack composition:
- 🔥 Next.js for Static Site Generator
- 🎨 Integrate with Tailwind CSS (w/ JIT mode)
- 💅 PostCSS for processing Tailwind CSS and integrated to
styled-jsx - 🎉 Type checking TypeScript
- ✅ Strict Mode for TypeScript and React 17
- ✏️ Linter with ESLint (default NextJS, NextJS Core Web Vitals and Airbnb configuration)
- 🛠 Code Formatter with Prettier
- 🦊 Husky for Git Hooks
- 🚫 Lint-staged for running linters on Git staged files
- 🗂 VSCode configuration: Debug, Settings, Tasks and extension for PostCSS, ESLint, Prettier, TypeScript
- 🤖 SEO metadata, JSON-LD and Open Graph tags with Next SEO
- ⚙️ Bundler Analyzer
- 💯 Maximize lighthouse score
- ☕ Minify HTML & CSS
- 💨 Live reload
- ✅ Cache busting
- 🚀 Docker for stack bootstrapping
- Node.js and npm
Run the following command on your local environment:
git clone https://github.com/Digital-Prophets/itez-frontend.git
cd itez-frontend
Run with docker and docker-compose in a single command below
docker-compose up --build
The above command will build and start the frontend service with live reload enabled.
Open http://localhost:3000 with your favorite browser to see the project.
Or manually you will need to first install all packages
npm install
Then, you can run locally in development mode with live reload:
npm run dev
Open http://localhost:3000 with your favorite browser to see the project.
.
├── README.md # README file
├── next.config.js # Next JS configuration
├── public # Public folder
│ └── assets
│ └── images # Image used by default template
├── src
│ ├── layout # Atomic layout components
│ ├── pages # Next JS pages
│ ├── styles # PostCSS style folder with Tailwind
│ ├── templates # Default template
│ └── utils # Utility folder
├── tailwind.config.js # Tailwind CSS configuration
└── tsconfig.json # TypeScript configuration
You can see the results locally in production mode with:
$ npm run build
$ npm run start
The generated HTML and CSS files are minified (built-in feature from Next js). It will also removed unused CSS from Tailwind CSS.
To create an optimized production build of assets, run:
npm run build-prod
At this point the platform is ready to be deployed. All generated files are located at out folder, which can be deployed.
For VSCode, you can have a better integration with VSCode by installing the suggested extension in .vscode/extension.json. The starter code comes up with Settings for a seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience.
Pro tips: if you need a project wide type checking with TypeScript, you can run a build with Cmd + Shift + B on Mac.
Everyone is welcome to contribute to the ITEZ project. Feel free to open an issue if you have question or found a bug.
Licensed under the MIT License, Copyright © 2021
See LICENSE for more information.
Made with ♥ by Digital-Prophets
