Adonis Rally

Adonis rally is a forum created using VueJs and AdonisJs. The API of the framework is written is Adonis and checkout the rally-frontend repo to grab the VueJs code.

Work in progress

Features

1. Show a list of questions on the homepage.
2. Ability to filter questions. Based upon channel and author.
3. Ability to sort by Latest, Popular.
4. Ability to create new questions.
5. Registration/Login.
6. Email verification.
7. Password reset.
8. Profile management.
9. Post answers to questions.
10. Choose favourite answer.

Setup

Setting up the project is quite easy. Start by cloning the repo.

clone

git clone https://github.com/adonisjs/adonis-rally

make install

Make install will perform all the require steps to setup the application for you.

make install

running the server

npm run dev

Tests

Tests are divided into multiple categories with Unit and Functional tests. Unit tests tests the isolated Repositories/Services, whereas Functional tests comes from outside in to test the controllers/routes.

Testing Environment

Testing environment is configured with the help of .env.test file. You are free to add/modify any variables here and they will be picked while running tests.

Running Tests

To run all tests

npm run test

To run unit tests

npm run test -- --filter=unit

To run functional tests

npm run test -- --filter=functional

Commands

make install

To setup the project for first time. It will run following commands

1. Copy .env.example to env cp .env.example .env.
2. Install package from npm. npm install.
3. Run all migrations. node --harmony_proxies ace migration:refresh
4. Seed database with a dummy user and channels. node --harmony_proxies ace db:seed

make update

Update the project by removing and re-installing all dependencies and re-running migrations.

🔥 update command will clear the database entries, so make sure you run it carefully.

Contributing

Feel free to fork and work on the missing parts of the application and create a PR for same. Make sure to work on small pieces of code with decent testing coverage before creating a PR.

Todo

• User Registeration/Send Verification Email
• Email verification
• Re-send verification email
• Login
• Create a new question (when loggedin)
• Paginate questions on the homepage.
• Sort questions by latest and popular on homepage
• Filter questions by author/channel.
• Update question (when loggedin and question owner)
• Delete question (when loggedin and question owner)
• View a single question.
• Add answer to a given question (when loggedin)
• Paginate answers on a given question.
• Edit/Update answer (when loggedin and answer owner)
• Delete answer (when loggedin and answer owner)
• Mark answer as a best answer.