Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #255

Open
wants to merge 1 commit into
base: pit
Choose a base branch
from
Open

Update README.md #255

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 9 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
[![Netlify Status](https://api.netlify.com/api/v1/badges/23b098eb-c146-4dea-96ed-287909bcda39/deploy-status)](https://app.netlify.com/sites/cherryontech/deploys)

# Welcome To Cherry On Tech's website
# 🎉 Welcome to Cherry On Tech's Website! 🌟

We are a tech squad! We support each other as we learn and grow in our tech careers. We got the idea from [Mo Hampton](https://twitter.com/MoxieHampton)'s [JuneteenthConf](https://www.juneteenthconf.com/) talk, "[Breaking into Tech](https://www.youtube.com/watch?v=2N5fI5j-IIs)." Learn more about us in an upcoming blog post!
We are a **tech squad** dedicated to supporting each other as we learn and grow in our tech careers. Our inspiration comes from [Mo Hampton](https://twitter.com/MoxieHampton)'s insightful talk at [JuneteenthConf](https://www.juneteenthconf.com/), titled "[Breaking into Tech](https://www.youtube.com/watch?v=2N5fI5j-IIs)." Stay tuned for an upcoming blog post to learn more about us!

## Tech Stack
## 🛠️ Tech Stack

This website is built using [Gridsome](https://gridsome.org/), a static site generator based on [VueJS](https://vuejs.org/). It's under pretty heavy construction, but we love it already, and we hope you do, too!
This website is built using [Gridsome](https://gridsome.org/), a static site generator based on [VueJS](https://vuejs.org/). While it's still under construction, we love it already, and we hope you do too! ❤️

## Installation
## 🚀 Installation

1. Make sure you have [node](https://nodejs.org/) installed. You can check by running `node --version`
1. Install Gridsome CLI tool if you don't have it: `npm install --global @gridsome/cli` or `yarn global add @gridsome/cli`
1. Clone the repo: `git clone https://github.com/cherryontech/website.git`
1. `cd website`
1. `npm install` or `yarn install`
1. Run `gridsome develop` to start a local dev server. In the terminal, you will see an address such as `http://localhost:8080/`. Navigate to that address in a browser to see the project in action.
Comment on lines -13 to -18
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue: The installation steps are important to remain here. If you'd like to enhance this section by moving the node check instructions (as you added on ln15), feel free to do that.

To get started with our project, follow these steps:

## Contributing

We welcome you to contribute to our "Tech Dictionary," where we share tech terms from different _perspectives_. To get involved, read [CONTRIBUTING.md](CONTRIBUTING.md).
Comment on lines -20 to -22
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue: This is a very important section and should not be removed.

1. Make sure you have [Node.js](https://nodejs.org/) installed. Check your installation by running:
```bash
node --version