Fix two XSS injections
[proj/recruiting-webapp.git] / README
1 This will be web based application for Gentoo Recruiters team.
2
3 To start testing application you should:
4
5 1.Install git.
6
7 1.1. External dependencies:
8      app-crypt/gpgme
9
10 2.Get sources
11
12   git clone git://git.overlays.gentoo.org/proj/recruiting-webapp.git
13
14   to get accepted sources (recommended). Or if you want latest sources and
15   don't mind fact that commit history will be rewritten a few times a day
16
17   git clone git://github.com/ahenobarbi/Gentoo-Recruiters-App.git
18
19 3.Install gems. Application uses bundler to manage gems so you should install bundler
20
21     gem install bundler
22
23   and then use bundler to install other gems
24
25     bundle install
26
27 4.Prepare configuration and databases.
28
29   rake prepare
30
31   You can pass db=sqlite3, db=postgres or db=mysql if you want rake to prepare database configuration for you.
32   You can pass seed= if you want rake to seed you database with example data.
33
34 5. (Optional) You can run test I prepared by simply issuing
35
36   rake
37
38 6. Start server
39
40   ruby script/server
41
42 it will be listening for connections on port 3000.
43
44 Configuration
45
46 In config/config.yml you can set:
47
48   developer_data:
49     check                       - Should developer data be checked (Gentoo join time for mentors)
50     data                        - String with developer data to use (overrides uri)
51     uri                         - URI from which developer data shall be obtained
52     min_months_mentor_is_dev: 6 - Number of months mentor must spend as Gentoo Dev before [s]h can became a mentor
53   seed:
54     users_domain                - Domain for emails of users from default seed
55
56 There is example of this file in doc/config/config.yml.
57
58 Seed
59
60 If you want to edit seed remember you can use erb in db/fixtures/*.yml files.