https://github.com/ustart-dev/ustart-scripts
https://github.com/ustart-dev/ustart-scripts
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ustart-dev/ustart-scripts
- Owner: ustart-dev
- License: mit
- Archived: true
- Created: 2019-08-27T13:56:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T03:28:59.000Z (about 3 years ago)
- Last Synced: 2025-03-21T15:22:02.387Z (9 months ago)
- Language: JavaScript
- Size: 707 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
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).