Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omargm2294/zemoga-fe-test
https://github.com/omargm2294/zemoga-fe-test
Last synced: about 4 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/omargm2294/zemoga-fe-test
- Owner: OmarGM2294
- Created: 2021-03-25T13:22:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-03-27T04:26:38.000Z (over 3 years ago)
- Last Synced: 2024-04-08T16:13:57.670Z (7 months ago)
- Language: JavaScript
- Size: 7.97 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Getting Started
First use the recommended node version:
```bash
nvm use
```
After that, install all dependencies:
```bash
npm i
# or
yarn install
```
Then, build the project:
```bash
npm run build
# or
yarn build
```
And run the project:
```bash
npm run start
# or
yarn start
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## Tools
This project was made with:
- [https://nextjs.org](NextJS)
- [https://babeljs.io](Babel)
- [https://jestjs.io](Jest)
- [https://eslint.org](Eslint)
- [https://prettier.io](Prettier)
- [https://enzymejs.github.io/enzyme/](Enzyme)
- [https://sass-lang.com/](Sass)
## Important notes
### Optimization
This project has been passed throught Lighthouse audits, values are almost perfect, things missing are related to server configuration.
### Working flow
The working flow is based in git flow with pre commit hooks (including prettier, jest tests and linter), also making a pull request template for each branch to be merged.
### Server side rendering
Server side rendering is been used to be more secure with api requests (api requets are made to get the necessary data).
### Images
Images were been optimized and each of them are been use with source set to improve performance in the site.
### PWA
PWA was not implemented because a server is required
### Sass
Styles were maded with SCSS to improve the code with imports, variables and mixins.