Giter Club home page Giter Club logo

gnosis-client's Introduction

Gnosis App

Gnosis is the common Greek noun for knowledge.

Bringing you informed and accessible research from around the world

The Gnosis App project was conceived and implemented at Craft Academy by the June 2019 cohort. Team members include Julie Ahlquist, Daria Lykova, Max Aubain, Pedro Bras, Erik Westerberg and Seth NeJame.

The purpose of this application is to bring the latest research of acadamia to the interested layperson in a friendly, readable format. Readers who are passionate about everything from climate change to cancer research can visit Gnosis for summaries on all of the latest issues. They can also leave feedback and offer support in the form of donations to the causes they are passionate about.

Another aspect of Gnosis is the ability to broadcast important issues facing the world today. Prominent research rroups associated with universities around the globe can sign up and submit their research so that readers can review it and make their own informed decisions on things concerning the environemtn, medicine, outreach programs.

A new news business model

explain business model here

Agile Project Management

This project utilizes the Agile approach to software development. We found this type of approach useful and efficient as it allows for requirements and solutions evolve through the collaborative effort of self-organizing and cross-functional teams and their customer(s)/end user(s).

The project design and implementation process for Gnosis can be viewed via our Pivotal Tracker dashboard.

Pivotal Tracker (PT) a popular softward development project management tool. If you have never used PT before, the dashboard can be initially disorienting. To make sense of the dashboard, it is useful to keep a few key ideas in mind.

  1. The unit of "progress" in an Agile development sprint is the "User Story". A User Story is a three-line description of a requirement of the application under development. For example, a story could be,
As a Vistor,
In order to get an overview of the content on Gnosis,
I would like to be able to see a list of research articles.
  1. User Stories are stored on the dashboard in the...
  • Icebox, where they are stored upon first creation.
  • The Current Iteration / Backlog, when they are voted upon by the team and made a priority.
  • And Done section, when they are merged with the shippable code base.
  1. Each story title on the dashboard can be expanded to reveal the full User Story, acceptance criteria, Model-Controller-View diagrams, resource links, difficulty points, etc.

  2. The User Stories are organized into Epics, which describe the types of functionality to be implemented in the application, such as "content-creation" or "monetization". Epics are assigned to User Stories as tags, so they are not mutually exclusive categories.

Code Repositories

Gnosis utilizes to code-base repositories hosted by Github. One code-base consists of a back-end API that manages business logic and data management, and the other comprises a front-end client which is largely devoted to controlling what the user interacts with in the browser window. These two repositories are connected and work together to create a working web application.

Gnosis Client-Side GitHub Repository: https://github.com/CraftAcademy/gnosis-client

Gnosis API-Side GitHub Repository: https://github.com/CraftAcademy/gnosis-api

Deployment

The front and back-end of the Gnosis App is deployed at the following location:

Front-End Deployment @ Netlify: https://gnosis-app.netlify.com/

Back-End Deployment @ Heroku: https://gnosis-api.herokuapp.com/

To interact with the Gnosis app, visit the Netlify link provided above and begin browsing your favorite topics.

Gnosis User Walk-Through

The Gnosis site is designed to accomodate four types of visitors: University administrators who manage their university's account; Research groups that are able to publish content on Gnosis when their parent University has obtained a subscription; Visitors who are interested in reading content; and Readers, who are registered Visitors.

We recommend using the following walk-through guides to explore our website when using the front-end deployment link above.

(features that have not been implemented yet are show in italics)

As a Visitor or Reader

Gnosis does not implement a subscription paywall for Visitors or Readers, so all content on the site is immediately avialble. The articles are available on the landing page, presented in order of most recently published.

The articles can be sorted a variety of ways. One option is to sort by category, which are listed in the Categories drop-down menu, such as Environment or Medicine. Another option is to sort by user location which is automatically imported by the application. Published articles have a city-tag to label where the research was accomplished, allowing Visitors and Readers to see published articles about research being accomplished near where they live, or where ever they may be.

Visitors can become registered Readers by using the sign up form accessible from the Sign Up button on the right side of the navigation bar.

As a University Administrator

The Univeristy Administrator, or "University" for short, is responsible for purchasing a subscription to enable Research Groups within the University to publish articles and generate donation revenue.

A University can sign up for a Gnosis account by clicking on the Sign Up button on the navigation bar at the top of the landing page. Using the resultant form and choosing University for the account type, a University account can be created with a successful form submission.

When sign up is accomplished, the University is automattically logged in and gains access to subscription portal. First, click on Subscribe in the navigation bar, and then fill out the payment information to obtain a subscription. DO NOT USE REAL PAYMENT INFOMRATION. The subscription can be triggered using the following test payment information.

Credit Card #: 4242 4242 4242 4242
Expire date: 12/22
CVC Number: 111

Upon submission of successful payment, five registration keys will be generated and released to the University account. Each key may be used once by a Research Group to create a Research Group account for content publishing. Therefore, one University account subscription can enable five Research Group accounts to be created.

As a Research Group

Research Groups that sign up with a University registration key are able to publish content on the site.

Like Readers and Universities, sign up is initiated by clicking on the Sign Up button on the right side of the navigation bar. A successful form submission in this case requires the selection of the Research Group option, the account information, and a valid registration key.

Any of the following registration keys may be used for Research Group sign up.

Gk1d6TPHSgCQcEzWAA1Yo5DD
MojWeMyGeTsQptAdsWuLxTg4
UpvLccdUtKY5RfZcqeisCiR6

When sign up is accomplished, the Research Group is automatically logged in and can begin to generate content by clicking on the Create Article button located in the navigation bar. An article can be submitted if it contains a location tag, a summary, and an attached research document in PDF format.

Test Driven Development for peace of mind

gnosis-client's People

Contributors

erikwesterberg avatar pedbr avatar sethnejame avatar julieahlquist avatar maxaubain avatar dashlykova avatar oliverochman avatar tochman avatar faraznaeem avatar dependabot[bot] avatar

Stargazers

Matt Ma avatar

Watchers

James Cloos avatar  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.