https://github.com/ustart-dev/ustart

NodeJS framework for building GraphQL backends using Apollo, Sequelize, Mongoose, Graphql shield and other great tools
https://github.com/ustart-dev/ustart

apollo graphql graphql-shield mongoose sequelize

Last synced: 2 months ago
JSON representation

NodeJS framework for building GraphQL backends using Apollo, Sequelize, Mongoose, Graphql shield and other great tools

• Host: GitHub
• URL: https://github.com/ustart-dev/ustart
• Owner: ustart-dev
• License: mit
• Created: 2019-04-12T20:48:09.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T21:44:10.000Z (almost 2 years ago)
• Last Synced: 2024-04-26T13:21:07.494Z (8 months ago)
• Topics: apollo, graphql, graphql-shield, mongoose, sequelize
• Language: JavaScript
• Homepage: https://ustart.dev
• Size: 3.56 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# uStart

uStart is a NodeJS framework for building GraphQL backends using Apollo, Sequelize, Mongoose and other great tools. Check out our site [ustart.dev](https://ustart.dev).

## Getting started

Ensure you have the latest [Node](https://nodejs.org/en/download/) installed

> You have to be on Node >= 8.x

Create a new folder for your project

```shell

mkdir awesome-project

cd awesome-project

```

Initialize with the ustart CLI. This will create the project structure and

install all NPM dependencies for you

```shell

npx ustart-cli init

```

We use `npx` to avoid global installation of the CLI. Once npx finish the `ustart-cli` will be available as a local package by typing `npx ustart `.

## Verfying Installation

Run your project

```shell

npm run start

```

If everything has gone well your console will log:

```

NODE_ENV: development

Server is running on http://localhost:4000

```

Good, that means you have running the playground on `localhost` port `4000`.

Execute your first query. Open your browser and open [localhost:4000](http://localhost:4000), go to the left panel and type:

```graphql

query {

  hello

}

```

Press the play icon in the middle of both panels, then the right panel should show:

```graphql

"data": {

  "hello": "Hello there, everything is right. You can keep reading the docs!"

}

```

If the response is the same you are ready to play!.

Go and try our first example on [ustart.dev](https://ustart.dev/docs/first-example-1).