boomak-server

README

Boomak — Server REST API Application

What is This?

Simple REST API based bookmarks storage and management web application. Don't expect something big or unique here—just another Pet Project to practice my skills in programming and web development. :-)

Repositories Structure

Repository	URL	Comment	Language
boomak-server (this repo!)	https://github.com/resurtm/boomak-server	Server backend	Go
boomak-client	https://github.com/resurtm/boomak-client	Web based client	JavaScript
boomak-cli	https://github.com/resurtm/boomak-cli	CLI based client	Go
boomak-clipy	https://github.com/resurtm/boomak-clipy	CLI based client	Python

Launching this Project

Development Environment

We assume that %PROJECT_DIR% is where your project located. First of all you have to download everything you need to launch it:

1. cd %PROJECT_DIR%
2. git clone git@github.com:resurtm/boomak-server.git
3. dep ensure

Now we can run the project:

1. Open new terminal, and run:
   cd %PROJECT_DIR
make serve
   This will run development server (automatically rebuilds the project & reloads the server on changes).

Production Environment

TBD:

License

Copyright 2017 resurtm

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.