Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/josejefferson/my-nodejs-template-builder
https://github.com/josejefferson/my-nodejs-template-builder
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/josejefferson/my-nodejs-template-builder
- Owner: josejefferson
- Created: 2021-12-30T22:36:03.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-01T17:28:03.000Z (about 3 years ago)
- Last Synced: 2024-04-28T23:25:55.099Z (9 months ago)
- Language: JavaScript
- Size: 933 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My Node.js template builder
Cria automaticamente um projeto Node.js com [Express](https://expressjs.com/) com algumas personalizações, baseado em meu modelo
## ❓ Como usar
```
git clone https://github.com/josejefferson/my-nodejs-template-builder.git project-name
cd project-name
npm install
node install.js
```
> Isto irá criar um diretório `project-name`
## 🚀 Executar
### Iniciar servidor (produção)
```
npm start
```
### Iniciar servidor (desenvolvimento)
```
npm run dev
```
### Build
```
npm run build
```
> Apenas se escolher SASS e/ou Gulp na [personalização](#-personalizações) do projeto
## 🔧 Personalizações
Ao executar o comando `node install.js` irá aparecer algumas perguntas sobre o projeto:
1) **Nome do projeto**
2) **Autor do projeto**
3) **Descrição do projeto**
4) **Criar um repositório [Git](https://git-scm.com/)?**
5) **Usar [ESLint](https://eslint.org/)?**
6) **Usar [SASS](https://sass-lang.com/)?**
7) **Usar [Gulp](https://gulpjs.com/)?**
8) **Usar [Socket.IO](https://socket.io/)?**
9) **Usar [EJS](https://ejs.co/)?**
10) **Usar [.env](https://www.npmjs.com/package/dotenv)?**
11) **Usar [Yarn](https://yarnpkg.com/)?**
> Baseado nas respostas, ao final, alterações às pastas e aos arquivos do projeto serão feitas e as bibliotecas necessárias serão instaladas
## 📁 Estrutura de arquivos
```
📂src/
├─ 📂css/...
├─ 📂img/
│ └─ 📂icons/...
├─ 📂js/...
├─ 📂lib/
│ ├─ 📂css/...
│ ├─ 📂fonts/...
│ └─ 📂js/...
├─ 📂scss/...
├─ 📄favicon.png
├─ 📄index.html
└─ 📄manifest.json
📂views/
└─ 📄index.ejs
📄.env
📄.eslintrc.json
📄.gitignore
📄gulpfile.js
📄index.js
📄package.json
```