Added readme
This commit is contained in:
parent
92b4eea347
commit
8463013322
21
README.md
21
README.md
|
@ -1,4 +1,21 @@
|
|||
# Webmarker
|
||||
A bookmark manager
|
||||
### A simple bookmark manager for all your links and resources
|
||||
|
||||
### Under Development...
|
||||
> This project is under development
|
||||
(error prone, missing features, etc...) feel free to contribute!
|
||||
|
||||
<image src="assets/1" style="width:50%; float: left;"></image>
|
||||
<image src="assets/2" style="width:50%; float: left;"></image>
|
||||
|
||||
## Setup
|
||||
### Linux/MacOS:
|
||||
1. Make sure the MongoDB database and collection is up and running.
|
||||
|
||||
2. Edit `/src/config.json` accordingly.
|
||||
|
||||
3. Head to the main folder using terminal and run: `(cd api && npm install) && npm install` for the dependancies.
|
||||
|
||||
4. Run `(cd api && npm run dev) & npm start` to start the application.
|
||||
|
||||
## Motivation
|
||||
One of the main reason I built this was so that I would start storing every information/resource I find in one place (Without any thirdparty services.)
|
||||
|
|
Ŝarĝante…
Reference in New Issue