Skip to content

Latest commit

 

History

History
159 lines (115 loc) · 4.87 KB

README.md

File metadata and controls

159 lines (115 loc) · 4.87 KB

Stars Issues License


Logo

Ignite Feed - Project #1

Project #1 of React trail of Ignite program by Rocketseat

View Live · Report Bug · Star

Table of Contents
  1. About The Project
  2. Getting Started
  3. License
  4. Acknowledgments

About The Project

ReactJS Ignite Logo

(back to top)

Built With

  • TypeScript
  • React
  • Vite

(back to top)

Getting Started

This project was done at Ignite following this Figma design, using CSS Modules inside React. You can access the project live here.

To run the project, you must follow these steps:

Prerequisites

You must have Node.JS LTS installed on your local machine to run this project. Optionally, you can also install pnpm (recommended).

Installation

  1. Clone the repo
    git clone https://github.com/ianlibanio/ignite-feed.git
  2. Install dependencies
  • pnpm
  pnpm install
  • npm
  npm install
  1. Run project in development mode
  • pnpm
  pnpm dev
  • npm
  npm run dev
  1. Enjoy! Now you can access the project at http://localhost:5173.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please open an issue describing what can be improved.

Don't forget to give the project a star! Thank you!

Contribution Guide:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

(back to top)


Made by Ian Libânio.