basic-front-app

basic-front-app is a ~~basic~~ front app code to start a project using React.js, Sass, Jest, TSLint and Webpack.

Summary

• Installation
• Quick start
• Features
• FAQ
• Contributing
• Special thanks

Installation

Fork it

To start your project, fork this one from the github page. You can also mirror it to another repository if you would like to keep being updated by the original one. Check this Github documentation on repository duplication and mirroring for more information.

Change it

Now that you have your own copy of the code, you should customize it by editing the following files:

• README.md: The edition depends on you.
• CHANGELOG.md: It should be empty.
• .gitignore: Remove the ttous.md line.
• package.json: You can change the name, version, description, author, homepage, repository and bugs properties.

Yarn it

After the app was put in your Github repository, you can install it locally as follow:

git clone https://github.com/<your_username>/basic-front-app
cd basic-front-app
yarn             # or 'npm i'

That's it!

You can finally start developing! No further configuration is needed: basic-front-app is intended to allow you to start coding as soon as it is installed.

Quick start

Development

Test

yarn dev_test    # or 'npm test'

Start

yarn dev_build   # or 'npm dev_build' (necessary only for the first run)
yarn dev         # or 'npm run dev'

Production

Test

To launch the tests, run:

yarn test        # or 'npm test'

Happy coding!

Features

basic-front-app implements a lot of features already put together for you to skip the ~~boring~~ configuration and go directly to the fun part!

• React.js for the frontend.
• Sass for the style.
• TSLint for the code.
• Jest for the tests.
• Webpack for the unity.

Contributing

Contributions are very welcome! Please check out the Code of Conduct before making your pull requests.

Special thanks

• Thanks to crsandeep and his repository (simple-react-full-stack) on which this one is based on.