Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/merklefruit/mern-template-antd
Boilerplate repository for MERN projects using Ant Design
https://github.com/merklefruit/mern-template-antd
antd mern-stack template
Last synced: 4 days ago
JSON representation
Boilerplate repository for MERN projects using Ant Design
- Host: GitHub
- URL: https://github.com/merklefruit/mern-template-antd
- Owner: merklefruit
- License: mit
- Created: 2020-04-22T14:41:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T20:36:32.000Z (about 1 year ago)
- Last Synced: 2024-11-16T08:31:06.594Z (2 months ago)
- Topics: antd, mern-stack, template
- Language: JavaScript
- Homepage:
- Size: 5.67 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MERN + Ant Design custom template
**I haven't found any good full-stack web app starter boilerplates using [Ant Design](https://ant.design), so I decided to make my own.**
**Feel free to use it on your projects.**
## Features
- [x] Landing Page
- [x] Ant-Motion animations
- [x] Sleek and modern design with the Ant Design library
- [x] Redux for State Management
- [x] Login/Register flow with JWT Authentication
- [x] Protected Routes:
- [x] Dashboard
- [ ] Profile
- [x] REST API Backend with Node.JS
- [x] MongoDB
- [x] Authentication with JWT
- [x] Easy configuration
## Usage
```bash
# Clone repository
git clone https://github.com/nicolas-racchi/mern-template.git
cd mern-template
# Install all dependencies both for client, server and wrapper folder.
cd client && npm install && cd ../server && npm install && cd .. && npm install
```
Then, connect your mongoDB database:
inside the `server` folder, create a file called `.env` and add the mongo connectionstring.
```bash
# Example (./server/.env)
NODE_ENV=development
DATABASE_URL=my_mongo_connection_string
```
A `.env.sample` file is provided in the server folder so you always know what are the required environment variables.
```bash
# Run client & server concurrently
npm run dev
```
## Other useful things
- **Locales**: Ant design supports language locales. As default, this template uses en_US (english). To change this setting to your own language, open `client/index.js` and change en_US to your own language based on locale tags (find some of them [here](https://www.oracle.com/java/technologies/javase/jdk8-jre8-suported-locales.html#util-text))
## Credits
_This template exists only thanks to the frameworks and library that I used to build it. I've just put the pieces together to make it easier to start a web app with this stack :)_
## License
**[MIT](./LICENSE)**