-
Notifications
You must be signed in to change notification settings - Fork 0
/
r2
136 lines (93 loc) · 4.92 KB
/
r2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# Omni-clied 2.0
Omni (or Omni-CLIed) is a powerful command-line interface (CLI) tool designed to streamline the process of creating fully functional Node.js servers and React.js applications. With Omni, you can generate server-side code that comes prepackaged with essential features like Google OAuth or customizable JSON Web Token (JWT) authentication and user models.
By leveraging Omni's intuitive and efficient CLI commands, developers can rapidly scaffold and initialize new projects, saving valuable time and effort. Whether you're starting a new web application or adding server functionality to an existing project, Omni empowers you to quickly set up secure and scalable server-side infrastructure.
Omni's seamless integration with Node.js and React.js allows developers to effortlessly create the server and client components required for modern web applications. The generated server code includes robust authentication options, such as Google OAuth or the flexibility to implement your own JWT-based authentication system. This makes it easy to authenticate and manage user accounts within your application.
With Omni, you can focus more on building the core features of your application rather than spending time on repetitive setup tasks. By automating the process of generating server-side and client-side code, Omni enables developers to jumpstart their projects and deliver high-quality applications faster.
[](https://oclif.io)
[](https://circleci.com/gh/oclif/hello-world/tree/main)
[](https://github.com/DugarRishab/omni-clied/blob/main/LICENSE)
<!-- toc -->
- [Omni-clied 2.0](#omni-clied-20)
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [`omni-clied help [COMMANDS]`](#omni-clied-help-commands)
- [`omni-clied node-server create DIR`](#omni-clied-node-server-create-dir)
- [Note:](#note)
<!-- tocstop -->
# Installation
Ypu can use it directly via npx:
```sh
npx omni-clied node-server create [DIR]
```
or you can install it either by cloning with git or by **npm** (recommended)
To install via npm:
```sh
npm i -g omni-clied
```
And omni-clied will be installed globally to your system path.
With a local installation, omni-clied will not be available in your system path or you can't use it directly from the command line. Instead, the local installation of omni-clied can be run by calling it from within an npm script (such as `npm start`) or using npx.
To install via yarn:
```sh
yarn global add omni-clied
```
To clone with git:
```sh
git clone https://github.com/DugarRishab/omni-clied
```
# Usage
omni-clied creates a template based on your choices. Your choices can be passed as flags.
Basic usage:
```sh
omni-clied [the-app-you-want] create [DIR] [options]
```
To create a node server with google OAuth pre-implemented:
```sh
omni-clied node-server create new-server --google-oauth
```
This will create a node server named '**new-server**' inside the root directory of your terminal. This server will have all functions required for google oAuth2.0.
An empty `config.env` file will be created inside the server which needs to be filled before running the server.
After the `config.env` file is updated accordingly, the server can be used as it is or can be used as a template for larger projects.
To see all available commands:
```sh
omni-clied --help
```
Or to see all available options:
```sh
omni-clied node-server --help
```
# Commands
## `omni-clied help [COMMANDS]`
Display help for omni.
```
USAGE
$ omni-clied help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for omni.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
## `omni-clied node-server create DIR`
create a new node-server
```
USAGE
$ omni-clied node-server create DIR [--user] [--auth] [--goauth] [--view]
ARGUMENTS
DIR Name or directory of the destination
FLAGS
--auth This will implement basic authentication using jwt cookies
--goauth This will basic authentication using google Oauth
--user This will add a userModel
--view This will implement server-side rendering
DESCRIPTION
create a new node-server
EXAMPLES
$ omni node-server create
```
## Note:
Currently, omni-clied only supports `node-server` but support for more applications will be released soon.
If you have an idea you would like us to add or you found a bug, please add them on the [issues](https://github.com/DugarRishab/omni-clied/issues) page of our Github. You can also write to me directly on this [email](mailto:[email protected])