https://github.com/sujeetkrjaiswal/feathers-sample-app

A full-stack sample application build using feathers.js and MongoDB (using mongoose) and react app for the client.
https://github.com/sujeetkrjaiswal/feathers-sample-app

Last synced: about 1 month ago
JSON representation

A full-stack sample application build using feathers.js and MongoDB (using mongoose) and react app for the client.

• Host: GitHub
• URL: https://github.com/sujeetkrjaiswal/feathers-sample-app
• Owner: sujeetkrjaiswal
• Created: 2020-07-12T16:12:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T11:18:58.000Z (almost 2 years ago)
• Last Synced: 2024-05-28T23:38:00.859Z (7 months ago)
• Language: TypeScript
• Homepage:
• Size: 11 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 37
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Feathers Sample Application

## Setting up sample Data

`data/input` folder has two json file one for customers and one for orders.

These files are generated using online sample data generators.

Run `npm start` in order to pre-process the generated files in order to 

map the customer._id to orders randomly and

set the `createdAt` and `updatedAt` to same value

Execute the below commands to import the data to your db.

```shell script

mongoimport --db feather-sample --collection customers --file ./data/output/customers.txt

mongoimport --db feather-sample --collection orders --file ./data/output/orders.txt

```

### Running the server

```shell script

npm start

# for dev mode

npm run dev

```

### Running the client

```shell script

# for local development

npm start

# for build

npm run build

```

### For production deployment

Steps to be setup in jenkins or any other CICD tool

```shell script

# step 1: build the client

cd client

npm install

npm run build

# step 2: move the build files to server/public (replace)

mv -r build/* ../server/public

# step 3: Build the server

npm install

npm run compile

```

Folders for interest/to be deployed to server

```text

server/lib/*

server/public/*

server/package.json

server/package-lock.json

```

## Screenshots of final output

### Analytics Page Screen

![Analytics](./assets/analytics.png)

### Order's List

![Orders List](./assets/orders.png)

### Customer's List

![Customers List](./assets/customers.png)

### Customer details page

![Customer Details](./assets/customer-details.png)

### Payload screenshot of `/customer`

![Payload](./assets/payload.png)

## How was the setup done

### Server

We are using feathers server. The project setup is done via below commands

```shell script

npm i -g @feathersjs/cli

# name: server (REST), authentication: true (local), mongoose data model for users

# with typescript

feathers generate app 

# customers: Mongoose

feathers generate service

# orders: Mongoose

feathers generate service

# analytics: Custom service

feathers generate service

```

### Client

Using standard `create-react-app`