EOSCR Web App Boilerplate

A highly scalable skeleton with best practices, ideal for React Web App projects quick start

Version

• 0.1.0

Features!

This boilerplate features all the latest tools and practices in the industry.

• React.js - React 16✨, React Router 5
• Rematch/core - Rematch a Redux Framework
• Material-ui/core - React components for faster and easier web development
• universal-authenticator-library - A library for allowing apps to easily use different auth providers (optional)
• Lint - ESlint
• Styles - Material-UI Theme (customizable)

Installation

Before to start

Somethings you need before getting started:

• git
• node.js
• yarn

First time

Copy the .env.example then update the environment variables according to your needs

cp .env.example .env

If you want to the boilerplate using UAL login integration, please make sure that REACT_APP_USE_UAL env variable is set as true.

Development

Quick start

1. Clone this repo using git clone --depth=1 https://github.com/eoscostarica/webapp-boilerplate.git <YOUR_PROJECT_NAME>
2. Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
3. Run yarn in order to install dependencies. At this point you can run yarn start to see the example app at http://localhost:3000.

File Structure

Within the download you'll find the following directories and files:

eoscrwebappboilerplate/
├── public
│   ├── index.html
│   └── manifest.json
├──  src
│   ├── api
│   ├── components
│   ├── config
│   ├── containers
│   ├── models
│   ├── routes
│   ├── theme
│   ├── utils
│   ├── App.js
│   ├── index.js
│   └── store.js
├── .dockerignore
├── .gitignore
├── .env.example
├── .eslintrc
├── .prettierrc
├── Dockerfile
├── LICENSE
├── README.md
├── docker-compose.yml
├── nginx.conf
└── package.json

License

MIT © EOS Costa Rica

Contributing

Please Read EOS Costa Rica's Open Source Contributing Guidelines.

Please report bugs big and small by opening an issue

Contributors

Thanks goes to these wonderful people (emoji key):

Xavier Fernandez 🤔 📝 📢 🚇

Teto Gomez 🤔 💻 👀

Adriel Diaz 🤔 💻 👀

This project follows the all-contributors specification. Contributions of any kind welcome!

About EOS Costa Rica

EOS Costa Rica is an independently-owned, self-funded, bare-metal Genesis block producer that provides stable and secure infrastructure for EOSIO blockchains. We support open source software for our community while offering enterprise solutions and custom smart contract development for our clients.

eoscostarica.io