Skip to content

Latest commit

 

History

History
76 lines (49 loc) · 2.8 KB

INSTRUCTIONS.md

File metadata and controls

76 lines (49 loc) · 2.8 KB

Rviewer skeleton: React

Twitter


This repository is a Typescript & Javascript skeleton with React, designed for quickly getting started developing a web application. Check the Getting Started for full details.

Technologies

Getting Started

Within the Makefile you can handle the entire flow to get everything up & running:

  1. Install make on your computer, if you do not already have it.
  2. Install the Yarn dependencies: make deps
  3. Start the application: make up

As you could see on the Makefile script, you could just avoid those steps and just execute make up, as deps are dependant of it.

Once these steps are finished, you could access to the application navigating into http://localhost:3000.

Overview

This skeleton is based on a Clean Architecture approach, so you could find the first basic elements:

You could find here an amazing Dev.to article explaining this Clean Architecture on frontend! (credits to @bespoyasov_).

UI layer

This folder contains the basic UI elements. You should add any UI element inside this folder, with the respective CSS file module.

Application layer

This layer is the one in charge of the different use cases of the application. A Use Case it's a workflow of what should it happen to a concrete Domain entity once interacts with the application.

This is the layer which would use any external service and communicate with the world (ie. APIs, databases, etc...)

Services layer

As we said, this is the layer that communicates the application with the outer world, and the one that would be coupled with almost any 3rd party provider, framework, etc...

Support

If you are having problems or need anything else, please let us know by raising a new issue.

License

This project is licensed with the MIT license.


Made with ❤️ by Rviewer