Skip to content

Commit

Permalink
Refactor README to remove deprecated content
Browse files Browse the repository at this point in the history
Signed-off-by: Nabarun Pal <pal.nabarun95@gmail.com>
  • Loading branch information
palnabarun committed Jun 6, 2020
1 parent 0d5434a commit f866be3
Showing 1 changed file with 7 additions and 54 deletions.
61 changes: 7 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,23 @@
Junction | [![Build Status](https://travis-ci.org/pythonindia/junction.svg)](https://travis-ci.org/pythonindia/junction) [![Coverage Status](https://coveralls.io/repos/pythonindia/junction/badge.svg?branch=master)](https://coveralls.io/r/pythonindia/junction?branch=master) [![Requirements Status](https://requires.io/github/pythonindia/junction/requirements.svg?branch=master)](https://requires.io/github/pythonindia/junction/requirements/?branch=master)
========

**DEPRECATED: Most of the time content here is deprecated**

Please have a look at https://github.com/pythonindia/junction/blob/master/docs/source/development/getting-started.rst for setting up the project.

Junction
---

Junction is a software to manage proposals, reviews, schedule, feedback during conference.

Setup
=====

It is advised to install all the requirements inside [virtualenv], use [virtualenvwrapper] to manage virtualenvs.

[virtualenv]: https://virtualenv.pypa.io/en/latest/
[virtualenvwrapper]: https://virtualenvwrapper.readthedocs.org/en/latest/

```
sudo apt-get update
sudo apt-get upgrade
sudo apt-get install libpq-dev python-dev build-essential tcl
pip install -r requirements-dev.txt
cp settings/dev.py.sample settings/dev.py
python manage.py migrate --noinput
python manage.py sample_data
sudo apt-get -y install redis-server
```

Initial auth data: admin/123123

Configuring Django-allauth
---------------------------

- Go to `http://localhost:8000/nimda/sites/site/`
- Change the default site's(the one with ID = 1) name and display to `localhost:8000`
- 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

Making Frontend Changes
---------------------------
Make sure you have nodejs, npm, bower, grunt-cli & grunt installed

```
$ cd junction/static
$ npm install
$ bower install
$ grunt // This starts a watcher to watch for file changes
```
[![Build Status](https://travis-ci.org/pythonindia/junction.svg)](https://travis-ci.org/pythonindia/junction) [![Coverage Status](https://coveralls.io/repos/pythonindia/junction/badge.svg?branch=master)](https://coveralls.io/r/pythonindia/junction?branch=master) [![Requirements Status](https://requires.io/github/pythonindia/junction/requirements.svg?branch=master)](https://requires.io/github/pythonindia/junction/requirements/?branch=master) [![Documentation Status](https://readthedocs.org/projects/in-junction/badge/?version=latest)](https://in-junction.readthedocs.io/en/latest/?badge=latest)

Junction is a software to manage proposals, reviews, schedule, feedback during conference.

Contributing
------------

1. Choose an [issue][issue-list] and ask any doubts in the issue thread.
2. Report any bugs/feature request as Github [new issue][new-issue], if it's already not present.
3. If you are starting to work on an issue, please leave a comment saying "I am working on it".
4. Once you are done with feature/bug fix, send a pull request according to the [guidelines].
4. You can set up the project using the [Getting Started][getting-started] guide.
5. Once you are done with feature/bug fix, send a pull request according to the [guidelines][guidelines].

[issue-list]: https://github.com/pythonindia/junction/issues/
[new-issue]: https://github.com/pythonindia/junction/issues/new
[guidelines]: https://github.com/pythonindia/junction/blob/master/CONTRIBUTING.md

### API

- HTTP API documentation is [here](https://github.com/pythonindia/junction/blob/master/docs/api.md).
- Python Client for junction is [here](https://github.com/pythonindia/junction-client).
[guidelines]: https://github.com/pythonindia/junction/blob/master/.github/CONTRIBUTING.md
[getting-started]: https://in-junction.readthedocs.io/en/latest/development/getting-started.html

License
-------
Expand Down

0 comments on commit f866be3

Please sign in to comment.