An open API service indexing awesome lists of open source software.

https://github.com/raid-guild/origin-stories

This is the place where our raiders gather to tell their stories. We'll learn about their journeys - why they decided to be a raider, any challenges βš” they've faced or achievements πŸ† they have uncovered and more.
https://github.com/raid-guild/origin-stories

mdx nextjs tailwindcss

Last synced: 3 months ago
JSON representation

This is the place where our raiders gather to tell their stories. We'll learn about their journeys - why they decided to be a raider, any challenges βš” they've faced or achievements πŸ† they have uncovered and more.

Awesome Lists containing this project

README

        

# **βš” Raider Origins βš”**

This is the place where our raiders gather to tell their stories. We'll learn about their journeys - why they decided to be a raider,any challenges βš” they've faced or achievements πŸ† they have uncovered and more.

## Our tools πŸ› 
This project uses:
- [Next.js](https://nextjs.org/) bootstrapped from [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
- [TailwindCSSπŸƒ](https://tailwindcss.com/docs) for managing our CSS
- [MDX](https://mdxjs.com/) to enable us to write JSX in Markdown files - for our stories

## Getting Started
1. Clone the repo - Check out the [docs](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) if needed
2. Go into your cloned repo and run the development server:
```bash
yarn dev
```
3. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
4. You can start editing!
- Pages in the `/pages/` folder
- Components in the `/components/` folder

## Important Files
We have some useful files that help us with our tooling.
- `/tailwind.config.js` is where we configure Tailwind, especially with theme values: fonts, colors etc.
- `/next.config.js` is where we configure our Next options but also our MDX options.

## Adding stories* (subject to change)
You can add stories by adding new Markdown file to the `/pages/origins` folder.