Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nelh/starwars-ppl
https://github.com/nelh/starwars-ppl
Last synced: about 22 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/nelh/starwars-ppl
- Owner: Nelh
- Created: 2021-03-25T18:30:32.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-03-28T22:04:33.000Z (over 3 years ago)
- Last Synced: 2024-07-25T04:47:31.677Z (4 months ago)
- Language: TypeScript
- Size: 1.47 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Starwars App
## Demo
Check the demo here https://afternoon-eyrie-44218.herokuapp.com/
## Description
A SPA build with React, Typescript, Graphql that utilize the starwars Api (https://swapi.dev/) to list all the Characters on the Starwars universe.
## Requirement
- Nodejs
- TypeScript
- React
## Installation
- You first need to clone the repository.
```javascript
git clone https://github.com/Nelh/React-Typescript-GraphQL-Project.git
```
## Server
- cd into the server folder
```javascript
cd React-Typescript-GraphQL-Project/server
```
Run npm install
```javascript
npm install
```
To start the Server, if you have yarn install run
```javascript
yarn dev
```
or
```javascript
npm run dev
```
You should see something like this on the terminal
```javascript
[nodemon] 2.0.7
...
[nodemon] starting `ts-node ./src/index.ts`
Running a GraphQL API server at 5000...
```
## Client
Open a new terminal and in the root folder cd into the client folder
```javascript
cd React-Typescript-GraphQL-Project/client
```
Run npm install
```javascript
npm install
```
Start the Server, if you have yarn install run
```javascript
yarn start
```
or
```javascript
npm run start
```
You will see something like this
```javascript
You can now view client in the browser.
Local: http://localhost:3000
On Your Network: http://192.168.88.251:3000
Note that the development build is not optimized.
To create a production build, use yarn build...
```
### Author
Nelh Armstrong