Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ouracademy/website
our website about software development :)
https://github.com/ouracademy/website
gatsby graphql grommet mdx react
Last synced: 2 days ago
JSON representation
our website about software development :)
- Host: GitHub
- URL: https://github.com/ouracademy/website
- Owner: ouracademy
- License: mit
- Created: 2018-12-22T03:25:36.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-03T16:28:19.000Z (about 1 year ago)
- Last Synced: 2024-04-18T10:53:39.937Z (9 months ago)
- Topics: gatsby, graphql, grommet, mdx, react
- Language: MDX
- Homepage: https://www.our-academy.org/
- Size: 10.5 MB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ouracademy
> Ouracademy is an organization that promoves the education in software development throught blog posts & videos 😃.
This website is created using [Gatsby](#resources), MDX & Grommet for UI. It uses many Gatsby plugins for offline, analytics (through Google Tag Manager), Syntax Highlight (through Prismjs) and GraphQL for fetching Github (to automatically generate versioning of posts).
It also has a `new-post` script to help you create new posts using inquirer.js.
---
## How write a post
- Clone this repository
- Install & Run it following [this steps](#development)
- Create .env file (similar to .env.sample file) and put your Github token there - this is used to fetch Github and versioning posts, [get your token here](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line).
- If you are a new author (put your information) in authors.yaml file.
- Run `npm run new-post` to create a new post
- Start writing, please follow this [guideline](#guide-for-commit-messages) to commit your post
### Guide for commit messages
We use [commit lint](https://conventional-changelog.github.io/commitlint/#/) in order to have a standard for commit messages. So if you create or update the content of a blog post, please use the `docs` type in your commit message, for example a commit message like `docs: new "post title"` is ok.
Also we use the `docs` type in our commit messages, to show a change history of every post (see `` component in `posts/template.js`).
---
## Development
```bash
npm install
npm run develop
```
Your site will run at `http://localhost:8000`!
> Note: You'll also see a second link: `http://localhost:8000/___graphql`. This is a tool you can use to experiment with querying your data.
### Some notes..🧐
We highly recommend that you install the recommended extensions if you use VS Code. It will make your development sweet 🍰
### Resources
This project use Gatsby. See more of it in its awesome[tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql), it has very useful resources not only to learn Gatsby but also GraphQL, React & plugins for any purpose...
If you don't know MDX, well it's just markdown & with JSX. So you could import components if you needed.
---
## License
[](/LICENSE)