Skip to content

Commit

Permalink
Merge pull request #17 from vgeruso/feature/cpn-node-structure
Browse files Browse the repository at this point in the history
Estrutura do node para nova versão 2.0.0
  • Loading branch information
vgeruso authored May 6, 2022
2 parents f4c7225 + 0a7d28b commit 7a73f04
Show file tree
Hide file tree
Showing 29 changed files with 1,523 additions and 288 deletions.
145 changes: 145 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@

# Created by https://www.toptal.com/developers/gitignore/api/node
# Edit at https://www.toptal.com/developers/gitignore?templates=node

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit

# End of https://www.toptal.com/developers/gitignore/api/node
37 changes: 9 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The cpn requires the following systems installed:
In the root directory `~/` execute:

```bash
$ wget https://raw.githubusercontent.com/vgeruso/cpn/1.3.0/install.sh
$ wget https://raw.githubusercontent.com/vgeruso/cpn/2.0.0/install.sh
```

```bash
Expand All @@ -37,25 +37,19 @@ $ bash install.sh

Run in a required folder:

If your project is JavaScript run:

```bash
$ cpn init my-project
$ cpn init -js my-project
```

In 'my-project' means the name of your project

Grant during the process a series of questions will be asked for the configuration of eslint, follow the recommended answers for an API, however this varies depending on the project and the time it is developing:

1. To check the syntax, find problems and apply the code style
2. JavaScript modules (import / export)
3. None of these
4. Node => Use space to unmark browser and mark node then press enter
5. Use a popular style guide
6. Airbnb
7. JavaScript
If your project is TypeScript run:

After answering the questions answer `yes` to install some dependencies through NPM.
```bash
$ cpn init -ts my-project
```

Completed all the settings of the script will show the following message:
'my-project' means the name of your project

To start your application:

Expand All @@ -75,17 +69,4 @@ $ yarn start

will be running on: http://localhost:3333/api/

### Others commands

Usage: cpn [ flag ] command [ arg ]

These are common cpn commands:

Perform maintenance on your cpn:
- update => Update cpn on your machine
- uninstall => Uninstal cpn from your machine

These are common cpn flags:
- -h or --help => Show this help list

Created by Victor Geruso
Loading

0 comments on commit 7a73f04

Please sign in to comment.