Giter VIP home page Giter VIP logo

ffxiv-list's Introduction

FFXIV-List

CI346 - Assignment

FFXIVList offers the possibility to track your in game progress for Final Fantasy XIV externally allowing for a better overview and faster searching capabilities.

As it is difficult to gauge how much you have done and how much is left, you can use FFXIVList to track your progress.

This website has been created for the purpose of an assignment for university.

Debug Instructions

This project has been built and tested on Windows 7 and Windows 10 on Firefox and Opera.

Building

  • Download the .Net Core SDK from the official microsoft page or get the latest version straight from the github repository.
  • Open command line.
  • Change directory to the ffxivList directory.
  • cd "FFXIV-List\ffxivList"

  • Enter the dotnet restore command to restore the dependencies and tools.
  • dotnet restore

  • Enter the dotnet publish command
  • dotnet publish -o publish -c Debug

  • Change directory to the publish directory.
  • cd publish

  • Enter the dotnet run dll command
  • dotnet ffxivList.dll

  • Open a browser on http://localhost:5000
  • Shut down website server when done in command line

Testing

  • Open command line.
  • Change directory to the ffxivList.Tests directory.
  • cd "FFXIV-List\ffxivList.Tests"

  • Enter the dotnet test command
  • dotnet test

Website Instructions

Login

You are able to sign up with your own account (It will default to standard user.) or with one of the following from the in memory database:

Note: If you create your own account, when you quit your session, the in memory database will forget you, however you will still exist on the auth0 authorization database.

Also, if you restart the server and you notice you are already logged in on the website, please relog to refresh the cookies.

You may receive a security warning on logging in stating that the information you have entered will be sent over an insecure connection and could be read by a third party.

You're username and email will be used for profiling purposes as well as creating a database entry for you to be able to store your user progress.

Authorization Levels

The website has several authorization roles which offer a different user experience:

  • Admin
  • Administrators are able to track their in game progress by checking checkboxes on their respective pages and view their profile as well as carry out any administrative needs on the website (e.g. creating, editing or deleting entries).

  • Standard User
  • A standard user is able to track their in game progress by checking checkboxes on their respective pages and view their profile.

  • Anonymous User
  • An anonymous user is only able to view pages but not track their in game progress. They also do not have access to a user profile.

Saving Progress

To start saving your in game progress, head over to the Levemetes, Quests or Crafts tabs available in the navigation bar after you have logged in.

Once you are there, you are able to check the relevant checkboxes and hit the Save button at the bottom of the screen to send your data to the database. You can instantly see your progress bar updating!

To see all your progress at once, check out your user profile.

Admin

After logging into an admin account (UserName: admin2, Password: test), head over to the Admin tab available in the navigation bar and select the entries you want to update.

Future Enhancements

  • No longer trigger a security warning on login.
  • More information on error pages.
  • Be able to delete users on auth0 from code.
  • Enhance database, add item relationship and show how many items is needed to complete tasks.

ffxiv-list's People

Contributors

cottonglow avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.