Skip to content

Latest commit

 

History

History
165 lines (114 loc) · 5.31 KB

README.md

File metadata and controls

165 lines (114 loc) · 5.31 KB
Raw

Ask Me Bro Logo

Every question has an answer. Learn and share knowledge with others. Initially by Rocketseat.

Made by Carlos Miguel Carlos Miguel Carlos Miguel Repository size
GitHub last commit License
Stargazers

Ask Me Bro Logo

🔖 Layout

You can view the project layout through the links below:

Remembering that you need to have a Figma account to access it.

🚀 Getting Started

Prerequisites

  • To run any ReactJS application you need to configure the environment on your machine.

  • Setting the environment is a simple process, so it's recommended to follow the Rocketseat guide which is currently the most complete and detailed to make the settings:

Rocketseat Guide

Clone

  • Clone this repo to your local machine using:
https://github.com/solrachix/ask-me-bro

Setup

  • Install project dependencies;

    • yarn install
// or
npm install

  • Run project in development mode;

    • yarn dev
// or
npm run dev

  • Be Happy! 😆

⚔ Challenges

  • Create Documentation
    • GIF
    • Example Video
    • Awesome Readme
    • Techs used
    • Project Setup
    • Features
    • Pages Prints
  • Improve Styles
    • Styled components styling
    • Few adjustments to make the style equal to the layout
    • Add Media queries
    • Create Theme Switcher
    • Create Dark Theme
  • Add PWA Feature
  • Add integration with Twitch

📋 Features

Build with

  • ReactJS - A JavaScript library for building user interfaces
  • Typescript - TypeScript is an open-source language which builds on JavaScript, one of the world’s most used tools, by adding static type definitions.
  • Next.JS - Next.js gives you the best developer experience with all the features you need for production: hybrid static & server rendering, TypeScript support, smart bundling, route pre-fetching, and more. No config needed.
  • Firebase - Firebase is a Backend-as-a-Service — BaaS — that started as a YC11 startup and grew up into a next-generation app-development platform on Google Cloud Platform.

🤔 Contributing

To get started...

Step 1

  • 🍴 Fork this repo!

Step 2

  • 👯 Clone this repo to your local machine using https://github.com/solrachix/ask-me-bro

Step 3

  • 🎋 Create your feature branch using git checkout -b my-feature

Step 4

  • ✅ Commit your changes using git commit -m 'feat: My new feature';

Step 5

  • 📌 Push to the branch using git push origin my-feature;

Step 6

  • 🔃 Create a new pull request

After your Pull Request is merged, can you delete your feature branch.

📌 Support

Reach out to me at one of the following places!

📝 License

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made by Carlos Miguel with 💙 Enjoy it!