@34fame/yoda 中文文档教程
Yoda
Yoda 是一个 CLI，用于协助管理全栈项目（即客户端和服务器）。
您将首先使用 yoda create 创建一个新项目。 只需为其提供一个名称，然后我们就可以走了。 系统将询问您是否要在项目中创建客户端和服务器。 假设您这样做并且将您的项目命名为 super-awesome-project，您将得到一个简单的结构，如下所示：
./super-awesome-project
L client
L server
在 0.0.1 版本中，一切都非常受限。
- You can only create a Client using Quasar Framework
- You can only create a Server using Firebase Cloud Functions
如果您没有使用其中任何一个，请随时贡献！ :smile:
对于那些使用 Quasar 和 Firebase 的人来说，您会爱上它的！
Getting Started
由于 Yoda 是一个 CLI 工具，您需要将其安装为全局包。
npm i -g @34fame/yoda
安装后，您只需键入 yoda 即可查看基本帮助。
- Run
yodafrom a directory that will be the parent to your project directory - READ THE DIRECTIONS found throughout the process. If not, you will likely have to wipe what you've done and start over.
- The current setup assumes you are using Quasar and Firebase as mentioned above. It also assumes you are using Auth0 for user authentication and for authorizing calls between your Client and Server. If you don't want to use this, that's fine, you'll just have to clear out those files after the install.
Yoda
Yoda is a CLI to assist with managing full stack projects (i.e. Client and Server).
You would start by using yoda create to create a new project. Just provide it with a name and away we go. You will be asked if you want to create a Client and a Server in the project. Assuming you do and you call your project super-awesome-project, you'll end up with a simple structure like so:
./super-awesome-project
L client
L server
In version 0.0.1 things are pretty constrained.
- You can only create a Client using Quasar Framework
- You can only create a Server using Firebase Cloud Functions
If you aren't using either of these, feel free to contribute! :smile:
For those of you who are using Quasar and Firebase, you are going to love this!
Getting Started
Since Yoda is a CLI tool, you need to install it as a global package.
npm i -g @34fame/yoda
Once installed, you can simply type yoda and see the basic help.
- Run
yodafrom a directory that will be the parent to your project directory - READ THE DIRECTIONS found throughout the process. If not, you will likely have to wipe what you've done and start over.
- The current setup assumes you are using Quasar and Firebase as mentioned above. It also assumes you are using Auth0 for user authentication and for authorizing calls between your Client and Server. If you don't want to use this, that's fine, you'll just have to clear out those files after the install.
