/one-boilerplate

one boilerplate to rule them all

Primary LanguageTypeScript

Contributors Forks Stargazers Issues

MIT License LinkedIn

💍 One Boilerplate to Rule Them All

Production ready react boilerplate for kickstart your next product!
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project (⚠️ UNDER DEVELOPMENT ⚠️)

One Boilerplate is a react boilerplate that includes state management, code splitting, service architecture, and more.

You can checkout this branch for old redux-saga implementation

(back to top)

Built With

(back to top)

Getting Started

It's simple as cloning the project!

Tip: You can use degit

Prerequisites

You need node@16 to run this boilerplate. You can use nvm or fnm to install the required version via .nvmrc file.

Installation

Install dependecies via npm or yarn

  • npm 
    npm install
  • yarn 
    yarn

(back to top)

Usage

  • Start up the development server

    yarn start

  • Test Project

    yarn test

  • Build Project

    yarn build

  • Lint

     yarn lint

Roadmap

  • Add state management
  • Add translations
  • Add lazy image component
  • Add test

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Batuhan Yenidunya - @batuhanyndny - batuhanyndny@gmail.com

(back to top)

Acknowledgments

This project uses create-react-app.

(back to top)