1.0.1 • Published 6 years ago
website-new-project v1.0.1
website-new-project
website-new-project
is a basic, solid template for creating a new project by
providing an already predefined set of features for the developers.
Installation
You must install yarn to have best performance (not npm
).
After that
> yarn add global webpack webpack-cli
Finally, run the template and enjoy:
> git clone https://github.com/Kana00/website-new-project.git
> cd website-new-project
> yarn install
> yarn start
Folder tree
- __tests__: where are the
Jest
unit tests. - assets : where are the
images/fonts/animations
. - components: where are the components of react used in this app.
- config: files that export javascript objects. they are called in several files. this allows to have a few parameters co-ordinate.
- i18n: where are all translation, and the function that allow you to use I18n translations.
- redux: stores the redux store, actions and reduce (a file
redux/action/listeAction
exist to avoid any collision of actions). - routes: react components that are displayed or hidden along the route. For this reason, these special components are in a special folder. We can say that these components are like screens that stores business react components.
- typings: TypeScript provides you with variable typing. Sometimes, having a lot of typing and their javascript documentation is heavy to read. This folder stores all the variable definitions and modules of our application and imports them dynamically into all the application. Thus, our files remains legible to read.
- utils: contains useful functions (or class) that are not react components. simply various tools (e.g.:
colorTools
).
- start.tsx: where
webpack
start and display our window. - App.tsx: where is stored the mount point of our react application.
Make the app in production
As simple as that:
> yarn build
After that, link all bundle files in a web server like nodeJS-Express, nginx, apache2,... etc
NOTE: we advise you to install these 2 extensions to improve the development experience:
If you want to use this template with Electron.js, you can use this repository : electron-new-project
License
Code is under the MIT License.
1.0.1
6 years ago