https://github.com/halbert-anderson/starter-name-generator-render

https://github.com/halbert-anderson/starter-name-generator-render

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/halbert-anderson/starter-name-generator-render
• Owner: halbert-anderson
• Created: 2024-03-24T08:51:13.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-03-24T10:24:25.000Z (8 months ago)
• Last Synced: 2024-03-24T11:23:51.717Z (8 months ago)
• Language: JavaScript
• Size: 244 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Starter Name Generator

## Installation

1. Fork this repository by clicking the Fork button at the top right of the page.

2. Clone this repository.

3. `cd` into the newly created directory.

4. Run `npm install`.

5. Run `npm start`.

Running `npm start` will run both the backend and the client.

## Existing files

This repository is set up as a monorepo, meaning that the client and backend projects are in one repository. This allows you to open both projects in the same editor.

The table below describes the folders in this starter repository:

| Folder/file path | Description                                                      |

| ---------------- | ---------------------------------------------------------------- |

| `./backend`      | The backend project, which runs on `localhost:5000` by default.  |

| `./client`       | The frontend project, which runs on `localhost:3000` by default. |

### GET /generate

Making a `GET` request to `/generate` will return a randomly-generated name.

## Notes:

This is meant to be deployed on Heroku. Fetching may take a few seconds while Heroku spins up the server.