https://github.com/tolumide-ng/modelling-fr

https://github.com/tolumide-ng/modelling-fr

atomic-design-pattern css heroku jest react react-testing-library typescript

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/tolumide-ng/modelling-fr
• Owner: tolumide-ng
• Created: 2021-04-16T11:42:34.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2021-04-26T22:39:23.000Z (over 3 years ago)
• Last Synced: 2023-03-06T08:17:25.753Z (almost 2 years ago)
• Topics: atomic-design-pattern, css, heroku, jest, react, react-testing-library, typescript
• Language: TypeScript
• Homepage:
• Size: 3.26 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Modelling frontend

The application is currently deployed on [Heroku](https://modellingapp-front.herokuapp.com/)

### Brief Description

#### TLDR

-   React

-   Typescript

-   CSS3 (Css Modules)

-   Atomic Design Pattern

-   Jest

-   React Testing Library

The frontend is written in `React` and `typescript`, It's styled with `CSS3`, adopts [css modules](https://github.com/css-modules/css-modules) for modularization, uses the `Atomic design pattern` and is tested with `Jest` and `React testing library`.

The frontend uses the atomic design pattern owing to the ease of understanding for new members of the application, its well strcutured nature, and minimal duplication of code.

### Suggested Deployment Model

-   The application can be deployed with heroku as it currently is or `GCP's` appEngine

### Local Deployment

-   Clone the repository

-   Ensure that you have nodejs installed on your local machine `preferably v12.x or later`

-   Provide the requsted environment variables as indicated on the `.env.sample` file (you can use `https://modelling-backend.herokuapp.com/` as the `BASE_URL`)

-   `cd` into the repository

-   Run `npm run dev` for local deployment