XsidX/hello-react-front-end

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Hello Rails Front-End

Hello Rails Front-End is a hello world front end project for a create react app consuming a rails back end api app.

🛠 Built With

Tech Stack

Client

• Reactjs

Key Features

Some features of the application.

• React
• Redux
• Api calls with createAsyncThunk

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• React.js
• Redux

Setup

Clone this repository to your desired folder:

Install

Install this project with:

• Clone the repository using git@github.com:XsidX/hello-rails-front-end.git
• Navigate to the folder using cd hello-rails-front-end

Usage

To run the project, execute the following command:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

Run tests

To run tests, run the following command:

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Deployment

You can deploy this project using:

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

(back to top)

👥 Author

👤 Sidney

• GitHub: XsidX
• Twitter: @_sid_o
• LinkedIn: Sidney Kaguli

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

🙏 Acknowledgments

I would like to thank microverse for providing the curriculum to guide me on this project.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)