From 7686ccffecfbbfea8082a614e2936ad98d9e5147 Mon Sep 17 00:00:00 2001 From: SeongUk Cho Date: Tue, 16 Aug 2016 22:03:11 +0900 Subject: [PATCH] Update README.md --- README.md | 98 +++++++++++++++++-------------------------------------- 1 file changed, 30 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 1abb305..dab92c3 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,37 @@ -# Welcome to Revel +# Open Bamboo for 대나무숲 -## Getting Started - -A high-productivity web framework for the [Go language](http://www.golang.org/). +## 사용된 오픈소스 -### Start the web server: +revel: A high-productivity web framework for the [Go language](http://www.golang.org/). +bootstrap +jquery - revel run myapp +## Getting Started +Open source Bamboo project + +## Prerequests for development + + 1. golang + 2. revel + +### Start the web server for development: + + 1. Download zipped source file + 2. unzip the source + 3. in any shell, type: revel run /*unzipped bamboo path*/ + 4. goto http://your-ip + 5. you can see bamboo page + Run with --help for options. -### Go to http://localhost:9000/ and you'll see: - -"It works" - -### Description of Contents - -The default directory structure of a generated Revel application: - - myapp App root - app App sources - controllers App controllers - init.go Interceptor registration - models App domain models - routes Reverse routes (generated code) - views Templates - tests Test suites - conf Configuration files - app.conf Main configuration file - routes Routes definition - messages Message files - public Public assets - css CSS files - js Javascript files - images Image files - -app - - The app directory contains the source code and templates for your application. - -conf - - The conf directory contains the application’s configuration files. There are two main configuration files: - - * app.conf, the main configuration file for the application, which contains standard configuration parameters - * routes, the routes definition file. - - -messages - - The messages directory contains all localized message files. - -public - - Resources stored in the public directory are static assets that are served directly by the Web server. Typically it is split into three standard sub-directories for images, CSS stylesheets and JavaScript files. - - The names of these directories may be anything; the developer need only update the routes. - -test - - Tests are kept in the tests directory. Revel provides a testing framework that makes it easy to write and run functional tests against your application. - -### Follow the guidelines to start developing your application: - -* The README file created within your application. -* The [Getting Started with Revel](http://revel.github.io/tutorial/index.html). -* The [Revel guides](http://revel.github.io/manual/index.html). -* The [Revel sample apps](http://revel.github.io/samples/index.html). -* The [API documentation](https://godoc.org/github.com/revel/revel). +### Start the web server for production + + 1. Download the zipped release file + 2. unzip the source + 3. goto unzipped bamboo path + 4. if using linux, start run.sh + 5. if using Windows, start run.bat + 6. you can see bamboo page on http://your-ip -## Contributing -We encourage you to contribute to Revel! Please check out the [Contributing to Revel -guide](https://github.com/revel/revel/blob/master/CONTRIBUTING.md) for guidelines about how -to proceed. [Join us](https://groups.google.com/forum/#!forum/revel-framework)! +Developed by ghatdev