|
1 | | -# Eruption 🌋 |
| 1 | +# how to publish |
2 | 2 |
|
3 | | -> Boilerplate for React/Typescript, built on top of Vite ⚡️ |
| 3 | +- run |
4 | 4 |
|
5 | | -_It's fast! Even the tests are fast, thanks to Vite with Vitest ⚡️_ |
6 | | - |
7 | | -# What's in the boilerplate |
8 | | - |
9 | | -- [Vite](https://vitejs.dev/) |
10 | | -- [React](https://reactjs.org/) |
11 | | -- [Typescript](https://www.typescriptlang.org/) |
12 | | -- [Vitest](https://vitest.dev/) |
13 | | -- [Testing Library](https://testing-library.com/) |
14 | | -- Dev Tools |
15 | | - - [ESLint](https://eslint.org/) |
16 | | - - [Prettier](https://prettier.io/) |
17 | | - - [CommitLint](https://commitlint.js.org/#/) |
18 | | - - [Husky](https://typicode.github.io/husky/#/) |
19 | | - - [Lint-Staged](https://github.com/okonet/lint-staged) |
20 | | - |
21 | | -# Installation |
22 | | - |
23 | | -There are two ways to install Eruption: using the template directly from GitHub (through the "Use Template" button), or using the [CLI](https://www.npmjs.com/package/create-eruption). |
24 | | - |
25 | | -If you want to use the CLI, run the following command on your terminal: |
26 | | - |
27 | | -```Bash |
28 | | -npm init eruption@latest |
29 | | -``` |
30 | | - |
31 | | -then, to start the project |
32 | | - |
33 | | -```Bash |
34 | | -cd your-project-name |
35 | | -npm install |
36 | | -npm run dev |
| 5 | +```bash |
| 6 | +npm login --scope=@<username> --registry=https://npm.pkg.github.com |
37 | 7 | ``` |
38 | 8 |
|
39 | | -## Using with Docker |
40 | | - |
41 | | -Pre-requisites: |
42 | | - |
43 | | -- Install [Docker](https://www.docker.com/get-docker) for your platform. |
44 | | -- Install [docker-compose](https://docs.docker.com/compose/install/) for your platform. |
45 | | - |
46 | | -### Try with Docker |
47 | | - |
48 | | -Making sure you're in your project directory, run: |
| 9 | +- authenticate with your github `username` and your `personal access token`: |
49 | 10 |
|
50 | 11 | ```bash |
51 | | -docker-compose -f docker-compose-dev.yml up |
| 12 | +Username: <username> |
| 13 | +Password: <personal access token> |
52 | 14 | ``` |
53 | 15 |
|
54 | | -### Using on Production with Docker |
55 | | - |
56 | | -DISCLAIMER: This Docker configuration is for demonstration purposes only. If you plan to use this configuration in a production remember to adjust the Dockerfile for your project's needs! |
57 | | - |
58 | | -Making sure you're in your project directory, run: |
| 16 | +- If you have the right access with your token, you can then publish your package: |
59 | 17 |
|
60 | 18 | ```bash |
61 | | -docker-compose -f docker-compose.yml up |
| 19 | +npm publish |
62 | 20 | ``` |
63 | 21 |
|
64 | | -_By default it uses port 80_ |
65 | | - |
66 | | -The production Dockerfile uses an nginx instance to run the built website, for more configuration options, see [nginx's dockerhub page](https://hub.docker.com/_/nginx) |
| 22 | +Then, if everything if your access is right, ti will be published to your github package registry and be available to install as a dependency in other projects: |
67 | 23 |
|
68 | | -## Try it online |
69 | | - |
70 | | -Want to try Eruption without clone local? Try it on [StackBlitz](https://stackblitz.com/fork/github/eruptionjs/core) |
71 | | - |
72 | | -# Commits |
73 | | - |
74 | | -This project have commits configured to follow the Conventional Commits's best practice and it's configured with ESLint, Prettier and Stylelint. |
75 | | - |
76 | | -To commit, you must follow the convention `<type>[optional scope]: <description>`. In practice, it would be as follow: |
77 | | - |
78 | | -```git |
79 | | -git commit -m "feat: add button component" |
| 24 | +```bash |
| 25 | +npm install @<username>/<package-name> |
80 | 26 | ``` |
81 | | - |
82 | | -Then, Husky will start the pre-commit hook and run lint-staged, who will run `prettier`, `lint` and `stylelint` to validate code format and code lint. If you fail to follow any of these validations, the commit will be aborted. |
83 | | - |
84 | | -After that, if everything is validated correctly, Husky will proceed with the commit-msg hook, where it will evaluate if your commit message is following the Conventional Commit's best practice and later run the tests of your project. If any of the tests are broken, the commit will be aborted. You must fix the tests before proceed. |
85 | | - |
86 | | -You can also commit your files with the help of the CLI. To do so, just run `npm run commit`. From there, the CLI will assist you in the proccess. As before: if your changes fails the validation, you must fix it before proceed. |
87 | | - |
88 | | -As a best practice, it is strongly recommended that you do not skip the validations. If you need to change the way your commit messages are written, just go to file `commitlint.config.ts` and you will find there the config needed. |
89 | | - |
90 | | -Check out [commitlint](https://commitlint.js.org/#/) docs to see further configurations that you can do. |
91 | | - |
92 | | -# Motivation |
93 | | - |
94 | | -Everything started because I was in need of a good, solid, reliable and fast boilerplate to work with React/Typescript projects. I was working with Create-React-App and Webpack but both of them wasn't that good at all, specially in performance. Later on I discovered that I could use Vite to replace Webpack, so here we are now. =) |
95 | | - |
96 | | -I believe that Eruption as it is right now, is an excellent starting point to any React/Typescript project, with enough dev tools to help you to write the best software possible and ship to production without any headaches. |
97 | | - |
98 | | -# License |
99 | | - |
100 | | -MIT |
0 commit comments