https://github.com/meteor/tutorials
The Meteor tutorials from meteor.com
https://github.com/meteor/tutorials
Last synced: 3 months ago
JSON representation
The Meteor tutorials from meteor.com
- Host: GitHub
- URL: https://github.com/meteor/tutorials
- Owner: meteor
- License: mit
- Archived: true
- Created: 2015-07-09T03:55:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-10-20T15:08:47.000Z (about 4 years ago)
- Last Synced: 2024-09-25T13:04:46.744Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.meteor.com/tutorials
- Size: 1.32 MB
- Stars: 181
- Watchers: 38
- Forks: 103
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
We no longer use this repository, we have now different repos for each technology:
- https://github.com/meteor/react-tutorial
- https://github.com/meteor/blaze-tutorial
- https://github.com/meteor/vue-tutorial
- https://github.com/meteor/svelte-tutorial
- https://github.com/meteor/angular-tutorial
# Official Meteor tutorials
This repository contains the content and view code for the official Meteor tutorials at [meteor.com](https://www.meteor.com/tutorials/blaze/creating-an-app).
Feel free to submit a pull request to improve the content!
### Tutorial content
1. [Blaze tutorial](https://www.meteor.com/tutorials/blaze/creating-an-app): [`/content/blaze`](https://github.com/meteor/tutorials/tree/master/content/blaze)
2. [Angular tutorial](https://www.meteor.com/tutorials/angular/creating-an-app): [`/content/angular`](https://github.com/meteor/tutorials/tree/master/content/angular)
3. [React tutorial - NEW FORMAT](https://react-tutorial.meteor.com): [`/content/react`](https://github.com/meteor/react-tutorial/)
4. [Vue tutorial](https://www.meteor.com/tutorials/vue/creating-an-app): [`/content/vue`](https://github.com/meteor/tutorials/tree/master/content/vue)
5. [Svelte tutorial](https://www.meteor.com/tutorials/svelte/creating-an-app): [`/content/svelte`](https://github.com/meteor/tutorials/tree/master/content/svelte)
### Tutorial step-by-step repositories
We also maintain all of the tutorials as step-by-step git repositories here:
1. [Blaze](https://github.com/meteor/simple-todos)
2. [Angular](https://github.com/meteor/simple-todos-angular)
3. [React - NEW FORMAT](https://github.com/meteor/react-tutorial/)
4. [Vue](https://github.com/meteor/simple-todos-vue)
5. [Svelte](https://github.com/meteor/simple-todos-svelte)
### Tutorial viewer
If you are editing the tutorials, use this simple app to view them: https://github.com/meteor/tutorial-viewer
## Tutorial workflow
### Editing the prose
Just edit the markdown files in `/content/`.
### Editing code snippets
The code snippets are generated from the step-by-step git repositories which are git submodules in `/repos`. Each code snippet is its own commit. Commit messages follow the following format:
```
Step 3.1: Add some feature
```
You might also want to make sure that all of your files end with a newline so that you don't get an annoying "No newline at end of file" diff.
After using `git rebase -i --root` to massage the repository into the desired state, run the script to update the generated files:
```sh
./scripts/process-repo.rb blaze
```
The commit with this message can then be included in the content with the following code snippet:
```html
{{> DiffBox step="3.1" tutorialName="simple-todos"}}
```
You should replace `simple-todos` with the correct tutorial name (defined by calling `DiffBox.registerTutorial`).
You're done! Make sure to commit the changes to all of the generated files.
## Repository layout
This repository is a Meteor package; it's currently not published, but you can clone it and use it as a local package in an app.
The different parts of the repository have quite different responsibilities, but they are somewhat tightly coupled so it doesn't make sense to split them into separate packages at this point.
3. `/content/` The actual tutorial prose content, in Markdown format.
4. `/generated/` (don't edit manually) This directory contains Git patch files generated from the step-by-step repos.
5. `/repos/` This directory contains git submodules of all three step-by-step tutorial repositories.
6. `/scripts/` This contains a script that is used to update `/generated/` from the repositories in `/repos/`.
## Updating Sub Modules
1. `git submodule update --init --recursive`
2. `meteor`