|
1 | | -Junction | [](https://travis-ci.org/pythonindia/junction) [](https://coveralls.io/r/pythonindia/junction?branch=master) [](https://requires.io/github/pythonindia/junction/requirements/?branch=master) |
2 | | -======== |
3 | | - |
4 | | -**DEPRECATED: Most of the time content here is deprecated** |
5 | | - |
6 | | -Please have a look at https://github.com/pythonindia/junction/blob/master/docs/source/development/getting-started.rst for setting up the project. |
7 | | - |
| 1 | +Junction |
8 | 2 | --- |
9 | 3 |
|
10 | | -Junction is a software to manage proposals, reviews, schedule, feedback during conference. |
11 | | - |
12 | | -Setup |
13 | | -===== |
14 | | - |
15 | | -It is advised to install all the requirements inside [virtualenv], use [virtualenvwrapper] to manage virtualenvs. |
16 | | - |
17 | | -[virtualenv]: https://virtualenv.pypa.io/en/latest/ |
18 | | -[virtualenvwrapper]: https://virtualenvwrapper.readthedocs.org/en/latest/ |
19 | | - |
20 | | -``` |
21 | | -sudo apt-get update |
22 | | -sudo apt-get upgrade |
23 | | -sudo apt-get install libpq-dev python-dev build-essential tcl |
24 | | -pip install -r requirements-dev.txt |
25 | | -cp settings/dev.py.sample settings/dev.py |
26 | | -python manage.py migrate --noinput |
27 | | -python manage.py sample_data |
28 | | -sudo apt-get -y install redis-server |
29 | | -``` |
30 | | - |
31 | | -Initial auth data: admin/123123 |
32 | | - |
33 | | -Configuring Django-allauth |
34 | | ---------------------------- |
35 | | - |
36 | | - - Go to `http://localhost:8000/nimda/sites/site/` |
37 | | - - Change the default site's(the one with ID = 1) name and display to `localhost:8000` |
38 | | - - Go to `Social Applications` in admin panel and add [Github](http://django-allauth.readthedocs.org/en/latest/providers.html#github) and [Google](http://django-allauth.readthedocs.org/en/latest/providers.html#google)'s auth details |
39 | | - |
40 | | -Making Frontend Changes |
41 | | ---------------------------- |
42 | | -Make sure you have nodejs, npm, bower, grunt-cli & grunt installed |
43 | | - |
44 | | -``` |
45 | | -$ cd junction/static |
46 | | -$ npm install |
47 | | -$ bower install |
48 | | -$ grunt // This starts a watcher to watch for file changes |
49 | | -``` |
| 4 | +[](https://travis-ci.org/pythonindia/junction) [](https://coveralls.io/r/pythonindia/junction?branch=master) [](https://requires.io/github/pythonindia/junction/requirements/?branch=master) [](https://in-junction.readthedocs.io/en/latest/?badge=latest) |
50 | 5 |
|
| 6 | +Junction is a software to manage proposals, reviews, schedule, feedback during conference. |
51 | 7 |
|
52 | 8 | Contributing |
53 | 9 | ------------ |
54 | 10 |
|
55 | 11 | 1. Choose an [issue][issue-list] and ask any doubts in the issue thread. |
56 | 12 | 2. Report any bugs/feature request as Github [new issue][new-issue], if it's already not present. |
57 | 13 | 3. If you are starting to work on an issue, please leave a comment saying "I am working on it". |
58 | | -4. Once you are done with feature/bug fix, send a pull request according to the [guidelines]. |
| 14 | +4. You can set up the project using the [Getting Started][getting-started] guide. |
| 15 | +5. Once you are done with feature/bug fix, send a pull request according to the [guidelines][guidelines]. |
59 | 16 |
|
60 | 17 | [issue-list]: https://github.com/pythonindia/junction/issues/ |
61 | 18 | [new-issue]: https://github.com/pythonindia/junction/issues/new |
62 | | -[guidelines]: https://github.com/pythonindia/junction/blob/master/CONTRIBUTING.md |
63 | | - |
64 | | -### API |
65 | | - |
66 | | -- HTTP API documentation is [here](https://github.com/pythonindia/junction/blob/master/docs/api.md). |
67 | | -- Python Client for junction is [here](https://github.com/pythonindia/junction-client). |
| 19 | +[guidelines]: https://github.com/pythonindia/junction/blob/master/.github/CONTRIBUTING.md |
| 20 | +[getting-started]: https://in-junction.readthedocs.io/en/latest/development/getting-started.html |
68 | 21 |
|
69 | 22 | License |
70 | 23 | ------- |
|
0 commit comments