https://github.com/kendoriddy/hello-react-front-end

https://github.com/kendoriddy/hello-react-front-end

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kendoriddy/hello-react-front-end
• Owner: kendoriddy
• Created: 2023-01-03T21:54:15.000Z (about 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-03T23:44:48.000Z (about 2 years ago)
• Last Synced: 2024-10-19T03:35:31.034Z (3 months ago)
• Language: JavaScript
• Size: 376 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Greeting App Frontend

This is a react frontend application built in preparation for building full stack web application using rails as the frontend.

## Backend Server

[Api server](http://localhost:3000/api/v1/greetings)

## Backend Source Code

[Source Code](https://github.com/kendoriddy/hello-rails-back-end)

## Built With

- React

- Redux

- CSS.

- Api.

### Prerequisites

The basic requirements for building the executable are:

- A working browser application (Google chrome, Mozilla Fire fox, Microsoft edge ...)

- VSCode or any other equivalent code editor

- Node Package Manager (For installing packages like Lighthous, webhint & stylelint used for checking for debugging bad codes before deployment)

# Getting Started

## Cloning the project

```

git clone  https://github.com/kendoriddy/hello-react-front-end.git 

```

## Getting packages and dependencies

To get all package modules required to build the project run:

```

npm install

```

every package module required to build the project is listed in the package.json file. this is used as a reference to get all dependencies.

## Building

To build the project run:

```

npm run build

```

After you run this sucessfully you'd locate the build from in the ```build``` folder located from the parent directory of the project.

## Running

To run the program on a browser through a server run this command in your cli

```

npm start

```

This should open the page in your localhost on port 3000. then you'd be able to view the built page generated using webpack.

## 🤝 Contributing

Feel free to check the [issues page](../../issues/).

## Authors

👤 **Kehinde Ridwan Onifade**

- GitHub: [@githubhandle](https://github.com/kendoriddy)

- Twitter: [@twitterhandle](https://twitter.com/RideOnOne09)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/kehindeonifade/)

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Microverse