Skip to content

Latest commit

 

History

History
96 lines (58 loc) · 2.74 KB

readme.md

File metadata and controls

96 lines (58 loc) · 2.74 KB
Codely

The codely command line utility.

Made by Greyson Mascarenhas Language count License

Installation   |    Usage   |    Contributing   |    License

Installation

Installation is as simple as running the following command (if you see EACCES error, reading fixing npm permissions may help):

npm install -g codely

or with yarn

yarn add global codely

Usage

Creating your project

Run the following command:

codely init

Then, answer the questions below:

  1. What is the name of the project?
  2. What do you want to code?

And then a folder will be created with the name of the project and with the selected subsystems.

Creating your react or react native component

Run the following command:

codely generate:component

Then, answer the questions below:

  1. What is the name of the component?
  2. Do you want to create the component using typescript?

And then a folder will be created with the name of the component inside src/components with an index file and a styles files.

Creating your react or react native page

Run the following command:

codely generate:page

Then, answer the questions below:

  1. What is the name of the page?
  2. Do you want to create the page using typescript?

And then a folder will be created with the name of the component inside src/pages with an index file and a styles files.

Creating a new controller

Run the following command:

codely generate:controller

Then, answer the questions below:

  1. What is the name of the controller?
  2. What methods do you want to use?
  3. Does your project use the JavaScript modules type (import/export)?
  4. Do you want to create the controller using typescript?

And then a file will be created with the name of the controller inside src/app/controllers.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Made with ♥️ by Greyson 👋