https://github.com/meteor/svelte-tutorial

https://github.com/meteor/svelte-tutorial

hacktoberfest meteor svelte tutorial

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/meteor/svelte-tutorial
• Owner: meteor
• Created: 2021-04-09T15:27:58.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-24T14:48:09.000Z (about 1 month ago)
• Last Synced: 2024-09-29T10:04:45.065Z (about 1 month ago)
• Topics: hacktoberfest, meteor, svelte, tutorial
• Language: Svelte
• Homepage: https://svelte-tutorial.meteor.com/
• Size: 6.03 MB
• Stars: 6
• Watchers: 14
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Meteor Svelte Tutorial

If you are looking for the tutorial, please go to [https://svelte-tutorial.meteor.com](https://svelte-tutorial.meteor.com) and check it there. 

This repository is the place to check the code (`src` folder) and to make contributions. 

Read in the tutorial home page where you should ask questions (spoiler: [Forums](https://forums.meteor.com) or [Slack](https://join.slack.com/t/meteor-community/shared_invite/enQtODA0NTU2Nzk5MTA3LWY5NGMxMWRjZDgzYWMyMTEyYTQ3MTcwZmU2YjM5MTY3MjJkZjQ0NWRjOGZlYmIxZjFlYTA5Mjg4OTk3ODRiOTc)).

This is a [hexo](https://hexo.io) static site used to generate the [Meteor Svelte Tutorial Docs](https://svelte-tutorial.meteor.com).

## Contributing

We'd love your contributions! Please send us Pull Requests or open issues on [github](https://github.com/meteor/svelte-tutorial). Also, read the [contribution guidelines](https://github.com/meteor/docs/blob/master/Contributing.md).

If you are making a larger contribution, you may need to run the site locally:

### Running locally

- Install [nvm](https://github.com/nvm-sh/nvm) to manage your Node.js (yes, this is an hexo project and not Meteor, in Meteor you don't need to worry about Node.js versions at all)

  `curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash`

- Install Node.js 8.11.2:

  `nvm install 8.11.2`

  

- Install the project

  `npm install`

- Run it

  `npm start`

  

### Styles and Lint

Make sure your changes are not breaking styles and lint rules, in the root project, run:

  - `npm install`

  - `npm run quave-check`

  

`quave-check` should not return any error or warning. If it does you need to fix them before sending a PR.

If you get an error because some npm modules are not resolved (`import/no-unresolved`) you need to run `npm install` inside the Meteor project that is throwing this error so you generate the `node_modules` folder for it.

We have a git hook to prevent commits that are not passing these rules but it's good to double-check as maybe your hooks set up can be messed up.

  

### Making a Pull Request

- Create a fork and make your changes on it.

- Test your changes and make sure you sync your code changes (`src` folder) with your text changes (`tutorial` folder).

- Build your changes:

`npm run build`

- Create your Pull Request against `master` branch.

- Sign the CLA.

- Wait for feedback or approval.