Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/therealjimoh/dogbreed
https://github.com/therealjimoh/dogbreed
aws axios bash-script docker eks-cluster helm-charts koa-router koajs kubernetes nodejs react-redux reactjs redux-toolkit sass
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/therealjimoh/dogbreed
- Owner: therealJimoh
- Created: 2022-04-26T13:29:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-24T10:46:41.000Z (over 1 year ago)
- Last Synced: 2024-12-06T08:04:47.756Z (about 1 month ago)
- Topics: aws, axios, bash-script, docker, eks-cluster, helm-charts, koa-router, koajs, kubernetes, nodejs, react-redux, reactjs, redux-toolkit, sass
- Language: JavaScript
- Homepage:
- Size: 674 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# A full stack web app that displays dog breeds and random fun activity - Dogs
This is the starter code for a [Node.js](https://nodejs.org/en/about/) server
using the [Koa web framework](https://koajs.com/). There is a frontend code in [React.Js](https://reactjs.org/) which should be served to the user.
## Getting started
To get this project functionally working locally;
- You will need to install Node.js.
For best results, use [**Node.js >= 16**](https://nodejs.org/).
You can check your current version of Node.js like this:
```sh
$ node --version
v16.13.1
```
- Download or clone the repo into your directory
- Use this command on your cmd or terminal
```sh
git clone https://github.com/therealJimoh/dogbreed
```
- Change into the root directory if you are not already there. Use:
```sh
cd dogbreed
```
- Then, inside this project, run
```sh
npm install
```
# To get the backend server running, run this in the project directory
```sh
npm run server
```
If the server starts successfully, you will see
```sh
Server running on http://localhost:3011
```
# To get the Frontend running
- Navigate to the frontend directory. Use this
```sh
cd frontend
```
Then, inside it, run
```sh
npm install
```
- To start the frontend application, change to the root directory of the project and run
```sh
npm start
```
If it starts successfully, you will see
```sh
You can now view in the browser at Local: http://localhost:3011
```
## Documentation
- Koa: https://koajs.com/
- @koa/router: https://github.com/koajs/router#koarouter
- koa-body: https://github.com/dlau/koa-body#usage-with-koa-router
- Dogs API: https://dog.ceo/dog-api/breeds-list
- Bored API: https://www.boredapi.com/
- React Library - https://reactjs.org/
- Redux Toolkit: https://redux-toolkit.js.org/
- React Hook Form: https://react-hook-form.com/
- SASS - https://sass-lang.com/documentation
- Axios - https://axios-http.com/