Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 101 lines (68 sloc) 4.017 kb
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
1 # Joind.in (http://joind.in)
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
2
3 This is the source code for the Joind.in website - a resource set up to allow
144a147 Elliot Ward Added changing base_url and api_base_url in config.php to vagrant setup ...
Eli-TW authored
4 events to get real-time feedback from those attending. It also gives speakers a
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
5 way to claim and track their presentations over time.
6
8ce7f73 Emma Jane New contributors are pointed to the current README file; however these i...
emmajane authored
7 This README includes instructions for setting up joind.in. You can either install
8 joind.in on an existing PHP platform, or use our vagrant setup. Note: contributors
9 should start at the Contributor readme (CONTRIBUTING.md).
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
10
f1413a1 Michael Maclean Add bold text
mgdm authored
11 PLEASE NOTE: **This project is now in maintenance mode.** Bug fixes are welcome, new features will not be accepted.
6d226fd Michael Maclean Add note about the site being in maintenance mode
mgdm authored
12
13 Please go to http://github.com/joindin/joindin-web2 to contribute to the next generation joind.in site: http://m.joind.in
14
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
15 ## Quick Start - Using Vagrant
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
16
474e833 Eric Hogue Fixed a typo
EricHogue authored
17 The virtual machine has been moved to a different repo. To use it [fork the joindin-vm](https://github.com/joindin/joindin-vm) repository and follow the instructions in there.
b569e84 Lorna Jane Mitchell updating the website readme to account for the move to the new API repo
lornajane authored
18
1887441 Eric Hogue Removed the instructions for the vagrant vm. The vm is in it's on repo
EricHogue authored
19 This VM will load all three Joind.in projects (joind.in, joindin-vm and joindin-web2).
a97dc6b Lorna Jane Mitchell fiddling with spacing to try to improve markdown formatting results
lornajane authored
20
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
21
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
22 ## Other Resources
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
23
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
24 * The main website http://joind.in
b569e84 Lorna Jane Mitchell updating the website readme to account for the move to the new API repo
lornajane authored
25 * Issues list: http://joindin.jira.com/ (good bug reports ALWAYS welcome! To get started, try an issue labelled "easy-pick")
26 * The API repo, which much of the website also depends on: https://github.com/joindin/joindin-api
1b1f76d Lorna Jane Mitchell adding a tiny bit more formatting and the jenkins link
lornajane authored
27 * CI Environment: lots of output and information about tests, deploys etc: http://jenkins.joind.in
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
28 * Community: We hang out on IRC, pop in with questions or comments! #joind.in on Freenode
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
29
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
30 See LICENSE file for license information for this software
31 (located in /doc/LICENSE)
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
32
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
33 ## Extensions
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
34
9fd5a51 Lorna Jane Mitchell re-organised and updated the readme with markdown format also
lornajane authored
35 ### Unit Tests
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
36
37 There are some tests set up, which use PHPUnit; these can be found in the
54bef99 David Stockton JOINDIN-260 phing task for making codesniff easy for contributors
dstockto authored
38 src/tests directory and the src/api-v2/tests directory. There is a phing task
39 configured to run them - from the root directory simply run "phing phpunit" to run
40 the tests. Unfortunately, there will be no output about whether the tests passed
41 or failed from the phing target. A better way to test when you are developing is
42 to run the tests from within the respective tests directory by just typing
43 phpunit. The phpunit.xml in each directory will configure the bootstrap as well
44 as any files that should not be included.
45
46 The phpunit.xml file in the src/tests directory will run all of the PHPUnit tests.
47 The phpunit.xml file in src/api-v2/tests will run only the API v2 unit tests.
48
49 ### CODE STYLE
50
51 Please do your best to ensure that any code you contributed adheres to the
52 Joind.in coding style. This is roughly equivalent to the PEAR coding standard with
53 a couple of rules added or taken out. You can run php codesniffer using phing on an
54 individual file like so:
55
56 phing phpcs-human -Dfilename.php
57
58 This will run codesniffer on any file within the regular source for Joind.in or the
59 API-v2 source. Wildcards work as does specifying part of the path in case the
60 filename alone results in sniffing more files than you wanted.
61
800034f David Stockton Merge branch 'phpcs-phing' into phpcs-for-humans
dstockto authored
62 To see a summary of the codesniff errors and warnings across the entire project, run
63
64 phing phpcs-human-summary
65
66 This will show the files that still need some attention.
67
4c4b36a Fabian Blechschmidt JOINDIN-467 Add paragraph about how to define global gitignore
Schrank authored
68 ## Global .gitignore
f656b47 Lorna Jane Mitchell copying README to readme markdown style
lornajane authored
69
9e55e04 Lorna Jane Mitchell tidying up the language in the readme
lornajane authored
70 git has the capability to define a global gitignore file , which means you can
71 set up rules on your machine to ignore everything you don't want to include in
72 your commits. This works not only for this project, but for all your other
73 projects too.
4c4b36a Fabian Blechschmidt JOINDIN-467 Add paragraph about how to define global gitignore
Schrank authored
74
9e55e04 Lorna Jane Mitchell tidying up the language in the readme
lornajane authored
75 You can define the gitignore file with a command that looks like this, where the
76 last argument is the file that holds the patterns to ignore:
4c4b36a Fabian Blechschmidt JOINDIN-467 Add paragraph about how to define global gitignore
Schrank authored
77
78 $ git config --global core.excludesfile ~/.gitignore_global
79
9e55e04 Lorna Jane Mitchell tidying up the language in the readme
lornajane authored
80 Octocat gives [a good starting point](https://gist.github.com/octocat/9257657) for
81 what to include, but you can also ignore the files used by your editor:
4c4b36a Fabian Blechschmidt JOINDIN-467 Add paragraph about how to define global gitignore
Schrank authored
82
83 # Eclipse
84 .classpath
85 .project
86 .settings/
87
88 # Intellij
89 .idea/
90 *.iml
91 *.iws
92
93 # Maven
94 log/
95 target/
96
97 # Netbeans
98 nbproject/private/
99
9e55e04 Lorna Jane Mitchell tidying up the language in the readme
lornajane authored
100 For more info on ignoring files, [github has an excellent help page](https://help.github.com/articles/ignoring-files/).
Something went wrong with that request. Please try again.