https://github.com/apollosoftwarexyz/create-cinnamon-project

Tool to create a Cinnamon project from a template
https://github.com/apollosoftwarexyz/create-cinnamon-project

apollo-software-limited cinnamon create project tool

Last synced: about 1 month ago
JSON representation

Tool to create a Cinnamon project from a template

• Host: GitHub
• URL: https://github.com/apollosoftwarexyz/create-cinnamon-project
• Owner: apollosoftwarexyz
• License: mit
• Created: 2023-11-10T23:01:01.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-29T21:37:27.000Z (about 1 year ago)
• Last Synced: 2024-11-05T15:12:52.325Z (3 months ago)
• Topics: apollo-software-limited, cinnamon, create, project, tool
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/create-cinnamon-project
• Size: 13.3 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# create-cinnamon-project

Create a new Cinnamon project with ease.

[Cinnamon](https://docs.apollosoftware.xyz/cinnamon) | [Apollo Software Limited](https://apollosoftware.xyz/)

Cinnamon is a framework for building web API backend applications. It is built

on Koa, and provides a declarative syntax for defining routes, middleware, and

more, that 'just works'.

## Prerequisites

Cinnamon is designed around `yarn` 2+, specifically and thus

requires it to be installed. You can install it with:

```bash

$ npm install -g yarn

```

## Expedited Setup

If you want to get started with Cinnamon as quickly as possible and your

project uses a database, before creating your project you should set up a

**PostgreSQL database** with the following credentials:

- **Hostname:** `localhost` (default)

- **Port:** `5432` (default)

- **Database:** `{project-name}`

- **Username:** `{project-name}`

- **Password:** `{project-name}123`

`create-cinnamon-project` will attempt to trigger an automatic database

migration with Cinnamon on project creation, and will use the above

defaults to do so.

Alternatively, pre-define a `cinnamon.toml` file in the root of your project

with the database credentials you wish to use.

> **Tip:** Select all of the features that Cinnamon offers in a stock install

> by pressing a on all of the feature selection prompts.

## Usage

```bash

$ yarn create cinnamon-project 

```

or with npm:

```bash

$ npx create-cinnamon-project 

```

## License

MIT License. See [LICENSE](LICENSE.md) for details.