Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ingeniousambivert/Feathers-React-Starter
Feathers-React Application Starter Kit
https://github.com/ingeniousambivert/Feathers-React-Starter
feathers react reduxtoolkit
Last synced: 3 months ago
JSON representation
Feathers-React Application Starter Kit
- Host: GitHub
- URL: https://github.com/ingeniousambivert/Feathers-React-Starter
- Owner: ingeniousambivert
- License: mit
- Created: 2020-10-10T05:14:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-27T11:34:33.000Z (10 months ago)
- Last Synced: 2024-07-06T00:06:16.317Z (4 months ago)
- Topics: feathers, react, reduxtoolkit
- Homepage:
- Size: 5.68 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-feathersjs - Feathers-React Starter
README
# Feathers-React-Starter
**MERN Stack** starter template with *Feathers*.
## About
This starter template is aimed towards SaaS apps. It constitutes of [**Feathers**](https://docs.feathersjs.com), [**MongoDB**](https://www.mongodb.com), [**React**](https://www.reactjs.org) and [**Redux Toolkit**](https://redux-toolkit.js.org/). It was bootstrapped with [Create React App](https://facebook.github.io/create-react-app/) and [Feathers Generator](https://docs.feathersjs.com/guides/basics/generator.html). It contains a pre-configured **REST API** with [**local authentication**](https://docs.feathersjs.com/api/authentication/local.html), [**authentication management**](https://github.com/feathersjs-ecosystem/feathers-authentication-management/blob/master/docs.md) and [**permissions/role management**](https://github.com/feathersjs-ecosystem/feathers-permissions) in the *server* and **state management** in the *web app*.
## Requirements
- [NodeJS](https://nodejs.org)
- [npm](https://npmjs.com) or [yarn](https://yarnpkg.com)
- [MongoDB](https://www.mongodb.com)
## Variants
- [ant-dev](https://github.com/ingeniousambivert/Feathers-React-Starter/tree/antd-dev) : React Web App customized with [Ant Design](https://ant.design)
- [tailwind-dev](https://github.com/ingeniousambivert/Feathers-React-Starter/tree/tailwind-dev) : React Web App customized with [Tailwind CSS](https://tailwindcss.com) (WIP)
## Installation
1. Clone the repository or use the [Github CLI](https://cli.github.com/) and create a new repository using this template.
```bash
git clone https://github.com/ingeniousambivert/Feathers-React-Starter.git
git checkout 'branch-name'
```
2. Use [yarn](https://yarnpkg.com/) or [npm](https://npmjs.com) to install all the dependencies.
```bash
cd directory (web / server)
yarn / npm install
```
## Built with
**Web** :
- [React](https://www.reactjs.org)
- [Redux Toolkit](https://redux-toolkit.js.org/)
**Server** :
- [Feathers](https://docs.feathersjs.com)
- [NodeJS](https://nodejs.org)
**Database** :
- [MongoDB](https://www.mongodb.com)
- [Mongoose](https://mongoosejs.com/)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Terms and License
- Released under the [MIT](https://choosealicense.com/licenses/mit/) License.
- Use it for personal and commercial projects, but please don’t republish, redistribute, or resell the boilerplate.
- Attribution is not required, although it is really appreciated.