Skip to content

Commit

Permalink
update getting started content, license date, contributing link, .git…
Browse files Browse the repository at this point in the history
…ignore & add custom `npm start` 🚀
  • Loading branch information
xavxyz committed Feb 2, 2017
1 parent e533dd4 commit cf0f8b8
Show file tree
Hide file tree
Showing 12 changed files with 486 additions and 95 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ bundle.tar.gz
jsdoc-conf.json
jsdoc.json
packages/nova-router/.npm
npm-debug.log
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

- Come check-in in the [Telescope Slack channel](http://slack.telescopeapp.org/). 👋

- Completely new features should be shipped as external packages with their own repos (see [3rd party packages](https://github.com/TelescopeJS/Telescope#third-party-plugins)). Don't hesitate to come by the [Slack channel](http://slack.telescopeapp.org/) to speak about it.
- Completely new features should be shipped as external packages with their own repos (see [3rd party packages](http://nova-docs.telescopeapp.org/plugins.html)). Don't hesitate to come by the [Slack channel](http://slack.telescopeapp.org/) to speak about it.

- We don't have test at the moment, and Travis integration is broken. If you know how to fix it, you are welcome (see [#1253](https://github.com/TelescopeJS/Telescope/issues/1253)!

Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

This is the Apollo/GraphQL version of Telescope Nova. [You can find the documentation here](http://nova-docs.telescopeapp.org/).

The fastest way to get started is:
```sh
npm install
npm start
```

### Other Versions

You can find the older, non-Apollo version of Telescope Nova on the [nova-classic](https://github.com/TelescopeJS/Telescope/tree/nova-classic) branch.
Expand Down
4 changes: 2 additions & 2 deletions license.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 Telescope Nova
Copyright (c) 2017 Telescope Nova

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
25 changes: 0 additions & 25 deletions npm-debug.log.14739240

This file was deleted.

25 changes: 0 additions & 25 deletions npm-debug.log.748773427

This file was deleted.

2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
"npm": "^3.0"
},
"scripts": {
"prestart": "sh prestart_nova.sh",
"start": "meteor --settings settings.json",
"lint": "eslint --cache --ext .jsx,js packages"
},
"dependencies": {
Expand Down
10 changes: 8 additions & 2 deletions packages/nova-getting-started/content/customizing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
If you want to learn how to customize Nova, we suggest checking out the [Read Me](https://github.com/TelescopeJS/Telescope) on GitHub.
If you want to learn how to customize Nova, we suggest checking out the [docs](http://nova-docs.telescopeapp.org) on GitHub.

The first things you'll want to do are probably create a `settings.json` file to hold all your settings, and then taking a look at the sample custom package by uncommenting `my-custom-package` in `.meteor/packages`.
The first things you'll want to do are probably create a `settings.json` file to hold all your settings, and then taking a look at the sample custom package by uncommenting `customization-demo` in `.meteor/packages`.

Here are two tutorials to get further:
* [Understanding the Nova Framework](http://nova-docs.telescopeapp.org/tutorial-framework.html )
* [Customizing & Extending Nova](http://nova-docs.telescopeapp.org/tutorial-customizing.html)

Happy hacking!
6 changes: 4 additions & 2 deletions packages/nova-getting-started/content/deploying.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Once you've played around with Nova, you might want to deploy your app for the whole world to see.

We recommend using [Meteor Up X (MupX)](https://github.com/arunoda/meteor-up/tree/mupx) to deploy to a [Digital Ocean](http://digitalocean.com) server, along with [Compose](http://compose.io) to host your database.
We recommend using [Meteor Up](https://github.com/kadirahq/meteor-up) to deploy to a [Digital Ocean](http://digitalocean.com) server, along with [Compose](http://compose.io) to host your database.

Other good alternatives include [Galaxy](http://galaxy.meteor.com/) and [Scalingo](http://scalingo.com).
Other good alternatives include [Galaxy](http://galaxy.meteor.com/) and [Scalingo](http://scalingo.com).

Learn more in the [Nova docs](http://nova-docs.telescopeapp.org/deployment.html).
12 changes: 2 additions & 10 deletions packages/nova-getting-started/content/getting_help.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
### Telescope Meta

If you have a question, the best place to ask is [Telescope Meta](http://meta.telescopeapp.org).

### Slack Chatroom

You can also drop by the [Slack chatroom](http://slack.telescopeapp.org) to get help or just say hello!

### Stack Overflow

Another good place to ask Telescope questions is [Stack Overflow](http://stackoverflow.com/questions/tagged/telescope). Just make sure you use the `telescope` tag!
If you have a question, the best place to ask is the [Slack chatroom](http://slack.telescopeapp.org) to get help. Or you can also drop to just say hello!

### GitHub Issues

Finally, if you've found a bug in Telescope, then please [leave an issue on GitHub](https://github.com/TelescopeJS/Telescope/issues).
If you've found a bug in Telescope, then please [leave an issue on GitHub](https://github.com/TelescopeJS/Telescope/issues).
12 changes: 12 additions & 0 deletions prestart_nova.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
purple=$(tput setaf 141)
blue=$(tput setaf 153)
bold=$(tput bold)
reset=$(tput sgr0)

test -f settings.json || (echo "🛠 ${blue}Creating your own settings.json file...\n"; cp sample_settings.json settings.json;)

echo "🔭 ${bold}${purple}Happy hacking with Telescope Nova!${reset}";

echo "📖 ${blue}The docs are available at: ${purple}http://nova-docs.telescopeapp.org";

tput sgr0;
Loading

0 comments on commit cf0f8b8

Please sign in to comment.