shane-lab / kwetter-aurelia

Kwetter frontend in Aurelia (babel)

Your #1 socialmedia platform.

Setup

Install Node or Yarn.

npm install # or | yarn install

After the dependencies have been installed, you may enter the following npm script to run the Aurelia application in developer mode:

npm run serve | # or yarn run serve

If running Aurelia CLI locally does not work, you may have to install the Aurelia CLI globally:

npm install -g aurelia-cli # or | yarn install -g aurelia-cli

Once the application is up and running, navigate to http://localhost:9000/.

Building the project

Run au build to build the project. The build artifacts will be stored in the scripts/ directory. Use the --env prod flag for a production build.

Testing the project

Run au test to test the project.

Functionality overview

services

• Authenticate users via JWT
• CRU* users (sign up & settings page - no deletion)
• CR*D Kweets (editor page - no updating)
• GET and display paginated lists of Kweets
  • Find by author
  • Find by favorited Kweets
  • Find with specific hashtag
• GET and display paginated list of profiles
  • Find by partial username
  • Find by followers
  • Find by following
• (Un)Favorite a Kweet
• (Un)Follow other users

routes:

• Home page (URL: / | /home )
  • List of trending hashtags of the week
  • Paginated list of Kweets pulled from either Feed (requires authentication), Global, or by selected trending hashtag
• Sign in/Sign up pages (URL: /login, /register )
  • Uses JWT (store the token in localStorage)
• Settings page (URL: /settings )
• Editor page (URL: /editor )
• Search page (URL: /search:q?)
  • Search for Kweets by hashtag or profiles by partial username
• Profile page (URL: /@/:username )
  • Show basic user info
  • Paginated timeline from author's created Kweets and author's favorited Kweets
  • Button to (un)follow a users (requires authentication)
  • Profile child pages
    • /@/:username/favorites: Paginated list of all favorited Kweets
    • /@/:username/followers: Paginated list of all followed users
    • /@/:username/following: Paginated list of all following users