Skip to content

gocedoko/couchdb-react-boilerplate

Repository files navigation

Build Status dependencies Status devDependencies Status Live Demo jest codecov

CouchDB-React Boilerplate

A single-page react app using a couchdb backend

This project can serve as a starting point for any kind of full-stack application. It uses the React.js framework, the Material-ui library, i18next for internationalization and has a fully functional user management using the CouchDB API.

Currently that's all there is to it. Feel free to check out the demo page, create a user, edit your profile and upload a photo.

The purpose of this project is to help you get started with a very clean and up-to-date setup. Very soon however, this project will receive some new features and become a complete social network framework, so stay tuned.

Get started

  1. Install, configure and run the Apache CouchDB database engine on ypur machine

  2. Open the Fauxton web interface: http://localhost:5984/_utils/index.html#login and log in

  3. Create a database

  4. git clone https://github.com/gocedoko/couchdb-react-boilerplate.git

  5. cd couchdb-react-boilerplate

  6. Update the database name in config.json

  7. npm install

  8. npm start

Contributing

Any suggestions and remarks regarding code style, libraries and used tools are very welcome via PR or email.

About

A single-page react app using a couchdb backend

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published