Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
LuanRoger committed Dec 11, 2023
1 parent 9ea8767 commit 6e5fe87
Showing 1 changed file with 73 additions and 1 deletion.
74 changes: 73 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,73 @@
# lr-tech-blog
<a href="https://lrtechblog.vercel.app">
<img src="https://github.com/LR-Tech-Blog/blog/blob/main/public/images/lr_logo.png" align="left" height="110"/>
<h1>LR Tech Blog</h1>
</a>

Wellcome to the LR Tech Blog, the personal blog of [Luan Roger](https://github.com/LuanRoger).
This is a blog where I will be posting about my projects, tutorials, and other things related to technology that I like to share. Hope you enjoy it!

## Tech stack

- 🚀 Astro
- 🎨 Tailwind CSS
- 📄 MDX
- 📡 [RSS](https://lrtechblog.vercel.app/rss.xml)
- 📦 Vercel

## Run locally

### Prerequisites

- [Node.js](https://nodejs.org)

### Step by step

Clone the project:

```bash
git clone https://github.com/LR-Tech-Blog/blog.git
cd blog
```

Install the dependencies:

```bash
npm install
```

Run the project:

```bash
npm run dev
```

## Contributing

Hey, I'm glad you're thinking about contributing to the blog!

### Important repositories

The blog is not all in this repository, you can check the organization's repositories to see the other repositories that are part of the blog. Here are some important repositories:

- [blog](https://github.com/LR-Tech-Blog/blog): This repository contains the blog's source code.
- [content](https://github.com/LR-Tech-Blog/content): This repository contains the blog's posts.

Before submitting your contribution, please consider this diclaimer:

- The content of the blog is written in Brazilian Portuguese, so all contributions must be written in this language.
- Besides the blog content, the code and GitHub related stuff are written in English, so all contributions must be written in this language.
- Although the content of the blog posts is open-source, it is only open to grammatical or informational corrections. Users are not allowed to post new content on the blog

### Issues

It's a good starting point to contribute to the blog. Check the open issues and see if you can help with any of them, if you found one that you are interested to help with, comment on it and wait for a maintainer to assign you to it, otherwise, someone else can be working on it and you will be wasting your time.

The issues is to be used to report bugs or sugest new features, so if you have any of these, feel free to open a new issue.

## Deploys

The blog has two deploys, one for the [production](https://lrtechblog.vercel.app) and another for the [development](https://lrtechblog-dev.vercel.app). The develop deploy is used to test new features before they are deployed to production, it is updated on every push to the `main` branch in this repository. At the same time, a preview deploy is triggered with the real blog content. Check the [deploy](https://github.com/LR-Tech-Blog/deploy) repository for more information.

## License

[MIT License © 2023 Luan Roger](https://raw.githubusercontent.com/LR-Tech-Blog/blog/main/LICENSE)

0 comments on commit 6e5fe87

Please sign in to comment.