SFPic is a web application built with React and NestJS and backed by CouchDB.
Live Demo is available at:
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
An installation of NodeJS at least v10.16.3 and CouchDB v2.3.1 is required before proceeding to installing the web app.
Make sure following commands are executing correctly with similar output.
$ node -v
v10.16.3
$ yarn -v
1.21.1
$ curl http://127.0.0.1:5984
{"couchdb":"Welcome","version":"2.3.1"}
To get instructions on how to install software mentioned above hit following links for NodeJS and CouchDB.
Alternatively you may want to use the PouchDB instead of CouchDB as a data storage for the app. However, if you thinking about that you probably don't require instructions.
A step by step series of examples that tell you how to get a development env running.
Checkout the repository.
$ git clone git@github.com:askhat/sfpic.git
$ cd sfpic
Install JavaScript dependencies.
# recommended
$ yarn
# or
$ npm install
Finally run the web app and its backend in a separate terminal.
$ yarn run web
# new window
$ yarn run backend
If everything has been set correctly navigate to http://localhost:1234 to see the app in action.
- add notes
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Askhat Bikmetov - Initial work - Askhat at GitHub
This project is licensed under the MIT License - see the LICENSE.md file for details
Special Thanks to Swen Wenzel for providing this gist under a quite permissive licencese.