Skip to content

Commit

Permalink
add VitePress, update README and update screenshot image and link
Browse files Browse the repository at this point in the history
  • Loading branch information
sonyarianto committed Apr 17, 2023
1 parent 89282c2 commit 1da8388
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,28 @@ Every web framework has their own cli to create project. Jogja will trigger the

## Features

- Trigger create project for Next.js, SvelteKit, Vue.js, Astro, Remix, Nuxt and many more.
- Trigger create project for AdonisJS, Angular, Astro, Aurelia, Ember.js, Express.js, Gatsby, Inferno, NestJS, Next.js, Nuxt.js, Nx, Preact, Qwik, React (creact-react-app/CRA), React Redux, Remix, Sails, SolidJS, SolidStart, SvelteKit, Vite, VitePress, Vue.js

## Installation

Install it globally
Install it globally.

```
npm i -g jogja
```

Now you can call it by type `jogja` on your computer. Use keyboard (up and down key) to select options.
Now you can call it by type `jogja` on your computer. Use keyboard (up, down and enter key) to select options.

## Screenshot

![Jogja](https://github.com/sonyarianto/jogja/blob/main/jogja-0.2.5.jpg?raw=true)
![Jogja](https://github.com/sonyarianto/jogja/blob/main/jogja-0.2.7.jpg?raw=true)

## FAQs

- **How to update?** Just run `npm i -g jogja` again. It will update the package to the latest version.
- **How to add new framework?** You can create PR to add new framework. Or you can create issue to request new framework.
- **I want to install non-JavaScript framework. Can I?** You can't at the moment. Support for other languages/frameworks will be added in the future.
- **Why the name is Jogja?** Jogja a.k.a Yogyakarta is the name of city in Indonesia. I want to make this project as a tribute to the city.
- **Why the name is `jogja`?** Jogja a.k.a Yogyakarta is the name of city in Indonesia. I want to make this project as a tribute to the city.

## License

Expand Down
Binary file removed jogja-0.2.5.jpg
Binary file not shown.
Binary file added jogja-0.2.7.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
"scripts": {
"start": "jiti ./src/index.ts",
"format": "prettier --write ./src",
"build": "tsup ./src/ --clean"
"build": "tsup ./src/ --clean",
"docs:dev": "vitepress dev jogja_vitepress",
"docs:build": "vitepress build jogja_vitepress",
"docs:preview": "vitepress preview jogja_vitepress"
},
"bin": {
"jogja": "./dist/index.js"
Expand Down Expand Up @@ -38,4 +41,4 @@
"cleye": "^1.3.2",
"picocolors": "^1.0.0"
}
}
}
3 changes: 2 additions & 1 deletion src/app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,8 @@ export async function mainMenu(
switch (selectedMenuValue) {
case "qwik":
case "nx":
// for qwik and nx, the project name will be handled by the cli itself
case "vitepress":
// for qwik, nx and vitepress, the project name will be handled by the cli itself
break;
case "solidjs":
// show options js or ts
Expand Down
39 changes: 39 additions & 0 deletions src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,159 +11,198 @@ export const projectTypeOptions = [
hint: "Deliver web apps with confidence",
cli: "npm init @angular",
category: "JS",
label: "",
},
{
value: "nextjs",
name: "Next.js",
hint: "The React framework for the web",
cli: "npx create-next-app@latest",
category: "JS",
label: "",
},
{
value: "nuxt",
name: "Nuxt.js",
hint: "The intuitive Vue framework",
cli: "npx create-nuxt-app",
category: "JS",
label: "",
},
{
value: "remix",
name: "Remix",
hint: "Build better websites. Create modern, resilient user experiences with web fundamentals",
cli: "npx create-remix@latest",
category: "JS",
label: "",
},
{
value: "svelte",
name: "SvelteKit",
hint: "Rapidly developing robust, performant web applications using Svelte",
cli: "npm create svelte@latest",
category: "JS",
label: "",
},
{
value: "vuejs",
name: "Vue.js",
hint: "The progressive JavaScript framework",
cli: "npm init vue@latest",
category: "JS",
label: "",
},
{
value: "astro",
name: "Astro",
hint: "Build the web you want",
cli: "npm create astro@latest",
category: "JS",
label: "",
},
{
value: "nestjs",
name: "NestJS",
hint: "A progressive Node.js framework",
cli: "npx nest new",
category: "JS",
label: "",
},
{
value: "emberjs",
name: "Ember.js",
hint: "A framework for ambitious web developers",
cli: "npx ember new",
category: "JS",
label: "",
},
{
value: "gatsby",
name: "Gatsby",
hint: "The fastest frontend for the headless web",
cli: "npx gatsby new",
category: "JS",
label: "",
},
{
value: "qwik",
name: "Qwik",
hint: "Framework reimagined for the edge!",
cli: "npm create qwik@latest",
category: "JS",
label: "",
},
{
value: "sails",
name: "Sails",
hint: "Realtime MVC framework for Node.js",
cli: "npx sails new",
category: "JS",
label: "",
},
{
value: "vite",
name: "Vite",
hint: "Next Generation Frontend Tooling",
cli: "npm create vite@latest",
category: "JS",
label: "",
},
{
value: "aurelia",
name: "Aurelia",
hint: "Simple. Powerful. Unobtrusive.",
cli: "npx aurelia-cli new",
category: "JS",
label: "",
},
{
value: "solidstart",
name: "SolidStart",
hint: "The Solid app framework",
cli: "npm init solid@latest",
category: "JS",
label: "",
},
{
value: "preact",
name: "Preact",
hint: "A different kind of library",
cli: "npx preact-cli create default",
category: "JS",
label: "",
},
{
value: "createreactapp",
name: "React (create-react-app/CRA)",
hint: "Set up a modern web app by running one command",
cli: "npx create-react-app",
category: "JS",
label: "",
},
{
value: "adonisjs",
name: "AdonisJS",
hint: "A fully featured web framework for Node.js",
cli: "npm init adonis-ts-app@latest",
category: "JS",
label: "",
},
{
value: "solidjs",
name: "SolidJS",
hint: "Reactive Javascript Library",
cli: "",
category: "JS",
label: "",
},
{
value: "inferno",
name: "Inferno",
hint: "An extremely fast, React-like JavaScript library",
cli: "npx degit infernojs/inferno-boilerplate",
category: "JS",
label: "",
},
{
value: "reactredux",
name: "React Redux",
hint: "A predictable state container for JavaScript apps",
cli: "",
category: "JS",
label: "",
},
{
value: "expressjs",
name: "Express.js",
hint: "Node.js web application framework",
cli: "npx express-generator",
category: "JS",
label: "",
},
{
value: "nx",
name: "Nx",
hint: "Smart, fast and extensible build system",
cli: "npx create-nx-workspace@latest",
category: "JS",
label: "",
},
{
value: "blitzjs",
name: "Blitz.js",
hint: "The missing fullstack toolkit for Next.js",
cli: "npx blitz new",
category: "JS",
label: "",
},
{
value: "vitepress",
name: "VitePress",
hint: "Vite & Vue powered static site generator",
cli: "npx vitepress init",
category: "JS",
label: "",
},
];

0 comments on commit 1da8388

Please sign in to comment.