Anemone - an application that centralizes users' documentation queries

Related tags

Web Applications project-anemone
Overview

Anemone

C. Sun, F. Imadegbelo, F. Johnston, T. Rowe, W. Zhai

Anemone is an application that centralizes users' documentation queries. A user will be able to search for references without leaving their current application. For unknown queries, default results will direct the user to sites like Google or Stackoverflow. The system will automatically save all query results.

Our software is primarily designed to help people who are interested in programming. The utmost intention of the software is to make it easy for people to query the web without going down rabbit holes. Users can create personal accounts through which they can store information, and log in to the same account to display historically stored information if the device is changed.

Comments
  • Git checkout b an 50 create login page

    Git checkout b an 50 create login page

    This branch contains both the html and css code required to create the user login page, together with the app icon. To run run the code, the repo should be cloned and opened through vscode or any preferred ide, checkout to this branch, navigate to the frontend folder and run the file "createLoginPage", it should request access to chrome.

    opened by faith-ima 5
  • Changed verification page to Faith's and removed the old version

    Changed verification page to Faith's and removed the old version

    At the moment, it looks like some css stuff is still broken on the page. I also had to remove the old "Resend Email" button because I need the route to be posted and not gotten. Basically, I needed to remove the href tag and replace it with the only thing I knew that would work. Someone needs to spend the time to fix the css and make sure that the button looks better than what I had to improvise with.

    I briefly tested registration, login, and logout, and everything seems to be working properly there. Just changed the link in the registration page to go directly to login.

    Also, not entirely sure what all the weird zone identifier stuff is all about, but it may be related the the css problem? If someone wants to explain that to me, that'd be ideal.

    opened by YouCopy 4
  • An 80 create email verification page

    An 80 create email verification page

    added email verification page that tells the user to go to their email to verify their account and includes an option to resend the email notification. To test page go to emailverify.html, right click, select copy path and paste in browser to view.

    opened by faith-ima 4
  • updated register page and added option for log in

    updated register page and added option for log in

    cleaned up the registration page and added an option for the user to be directed to the login page(needs backend connection). Should I remove the section with the coupon and the "get in touch"? The latter can be changed to info pertaining to electric bluefish productions

    opened by faith-ima 2
  • Flask Implementation

    Flask Implementation

    I tried experimenting with Laravel's own methods to call python scripts, but none of those worked so I went with Flask instead. There might be some weird pip install errors when testing everything, but if you need help getting everything setup, we can struggle together.

    Flask is basically another API that doesn't connect to Laravel whatsoever. The idea is to contact the flask api when submitting a url for webscraping, and the python function will send the results directly to the mysql database. After which, when searching for an item, the frontend will contact Laravel to retrieve the data stored within the database.

    To test, have everything open as normal, run app.py in the public folder, and then send the request in postman.

    opened by YouCopy 1
  • AN-61 reintroduce swagger & publish v1 api doc

    AN-61 reintroduce swagger & publish v1 api doc

    For a few reasons, one being the revision of our Design Document Part II and two serving documentation on our About page, we want to integrate Swagger OpenAPI documentation into Anemone. This describes the models of our project and their behavior (en route).

    Jira:

    AN-61 Install Swagger

    opened by avariantphi 1
  • Set up routes for user & document request-response cycles

    Set up routes for user & document request-response cycles

    AN-72 Please review the current changes (they are still work in progress). I have added to the document controller and its data Model There are some updates to the user controller as well Nothing is hooked up to the document db, yet.

    opened by avariantphi 1
  • AN-62 define api spec & control(s) in project anemone

    AN-62 define api spec & control(s) in project anemone

    AN-62 Capture our User, Document, and Search endpoint specifications Add User endpoint testing template add User controller (to begin templating the hooking up of our front-end to back-end)

    opened by avariantphi 1
  • AN-42 Create DB and create User table

    AN-42 Create DB and create User table

    Typically, PRs encapsulate small changes. PRs are typically 6 files or less. Given the Laravel skeleton, this PR is an exception.

    The point of this pull request was to create a database source and the User table. The effort is contained within the Laravel skeleton since the database source is created via script within the Laravel project.

    The next steps are to be able to test retrieve user information and request user registration.

    opened by avariantphi 1
  • NO JIRA Refine scraper app configs

    NO JIRA Refine scraper app configs

    It's usually best practice to lock in the versions of dependencies, to avoid breaking changes when reliant software is updated. It is also best practice to have a .dockerignore file

    opened by avariantphi 0
  • NO JIRA Implement Search feature

    NO JIRA Implement Search feature

    As a user of Anemone, one can now query their personal store in Anemone. The endpoint as have been added to our Postman Collection

    • /search is a dashboard view of the search feat
    • /search/autocomplete?q= is the endpoint that will search the database associated with your account There is an example in the Postman Collection showing how to build a simple query. At this point, you can search by name or file type, whatever is in the record's path name attribute will be found.
    Screen Shot 2022-04-24 at 10 03 07 PM
    opened by avariantphi 0
Releases(v3.0.0)

  • v3.0.0(Apr 25, 2022)

    What's Changed

    • AN-100 + AN-129 Formatting and dynamic scraping by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/28
    • An 144 update swagger documentation by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/30
    • Updated migration tables by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/31
    • Flask Implementation by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/32
    • Ap 65 dockerize anemone services for ebp deployment by @ApplebaumIan in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/33
    • Added easy testing for the scrapper using the typical sail command. by @ApplebaumIan in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/34
    • NO JIRA Refine scraper app configs by @avariantphi in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/36
    • NO JIRA Implement Search feature by @avariantphi in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/35

    New Contributors

    • @ApplebaumIan made their first contribution in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/33

    Full Changelog: https://github.com/Capstone-Projects-2022-Spring/project-anemone/compare/v2.0.0...v3.0.0

    Note: Please see the README.md for bug information listed in v2.0.0 release

    User Testing

    Route Testing

    First, set up your dev environment by installing docker, the application repository, and vendor (ask team for assistance if need be) Second, migrate your dbs with vendor/bin/sail artisan migrate Third, you need request access to Anemone's POSTMAN collection Once granted access, you need to do the following customizations for each route:

    /register: change the key values in the body tab every time you make a new account, you are automatically logged into the app from this step, you can use the token returned in your logout endpoint /login: change the key values in the body tab to an account you have in your database (if need be you should be able to grab the id (e.g. 1) of the user you registered /logout: change the token in the authorization tab to a valid one every time you logout /documents: create a Postman/files/ in your home directory, place any test file here, then change the image value in the body tab to a file you have on your machine /documents/user_id/id: change the two numbers in the url (user_id, id) to a valid user id and to a valid doc id in your documents table. Keep in mind that you can only access a specific document if you have both a correct user_id and documents id /scrape: enter a public URL you want to have scraped /autocomplete?query=: enter a query parameter (such as png) to search your stored documents

    Source code(tar.gz)
    Source code(zip)

  • v2.0.0(Apr 13, 2022)

    What's Changed

    Everything under the 🌞

    • We migrated our UI to the Anemone Frontend
    • AN-78 remove all dead /user code by @avariantphi in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/16
    • An 100 upload pdf data by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/22
    • AN-61 reintroduce swagger & publish v1 api doc by @avariantphi in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/23
    • Files display after user upload by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/24
    • Create Scraper.py by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/25
    • NO JIRA - Update L5_SWAGGER_CONST_HOST by @avariantphi in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/26
    • An 128 tokenize backend by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/27

    API Publishing

    Please reference SWAGGERME.md the latest state of the API can be viewed at our API docs

    Route Testing

    First, set up your dev environment by installing docker, the application repository, and vendor (ask team for assistance if need be) Second, migrate your dbs with vendor/bin/sail artisan migrate Third, you need request access to Anemone's POSTMAN collection Once granted access, you need to do the following customizations for each route:

    • /register: change the key values in the body tab every time you make a new account, you are automatically logged into the app from this step, you can use the token returned in your logout endpoint
    • /login: change the key values in the body tab to an account you have in your database (if need be you should be able to grab the id (e.g. 1) of the user you registered
    • /logout: change the token in the authorization tab to a valid one every time you logout
    • /documents: create a Postman/files/ in your home directory, place any test file here, then change the image value in the body tab to a file you have on your machine
    • /documents/user_id/id: change the two numbers in the url (user_id, id) to a valid user id and to a valid doc id in your documents table. Keep in mind that you can only access a specific document if you have both a correct user_id and documents id

    Contributors

    • @avariantphi tested contributions with some minor upgrades
    • @YouCopy made the most contributions

    Full Changelog: https://github.com/Capstone-Projects-2022-Spring/project-anemone/compare/v1.0.0...v2.0.0

    Source code(tar.gz)
    Source code(zip)

  • v1.0.0(Mar 15, 2022)

    What's Changed

    • AN-42 Create DB and create User table by @avariantphi in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/1
    • AN-62 define api spec & control(s) in project anemone by @avariantphi in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/5
    • AN-28 validate user credentials by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/6
    • AN-67 loading css files in php by @Necosama in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/7
    • AN-49 Add documents table w/ successful migrate script by @avariantphi in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/9
    • An-69 user drop down menu by @faith-ima in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/11
    • AN-73 verify user email addresses by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/10
    • AN-68 user logout by @YouCopy in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/12

    New Contributors

    • @avariantphi made their first contribution in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/1
    • @YouCopy made their first contribution in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/6
    • @Necosama made their first contribution in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/7
    • @faith-ima made their first contribution in https://github.com/Capstone-Projects-2022-Spring/project-anemone/pull/11

    Full Changelog: https://github.com/Capstone-Projects-2022-Spring/project-anemone/commits/v1.0.0

    Source code(tar.gz)
    Source code(zip)
Owner
Temple University, CIS department
Capstone Projects in 2022 Spring Semester
Temple University, CIS department
GitHub
Online personal and group chat application using HTML, CSS, JS, PHP,SQL and AJAX that allows users to create own groups, chat

Online personal and group chat application using HTML, CSS, JS, PHP,SQL and AJAX that allows users to create own groups, chat, make friends, check new notifications and edit functionality. Chat automatically updates using AJAX to allow for real-time chatting with other users collected from the database.

Dave Sharma 2 Aug 5, 2022
A platform to create documentation/wiki content built with PHP & Laravel

BookStack A platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://w

BookStackApp 10.6k Jan 3, 2023
Easily self host your documentation.

Docs for Laravel Generate docs for your projects Support us Like our work? You can support us by purchasing one of our products. Installation WIP, do

Flowframe 6 Oct 31, 2022
A platform to create documentation/wiki content built with PHP & Laravel

BookStack A platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://w

BookStackApp 10.6k Dec 29, 2022
Cakephp-book allows you to search in the official CakePHP documentation directly from the console.

CakeDC/Book plugin for CakePHP cakephp-book allows you to search in the official CakePHP documentation directly from the console. Requirements CakePHP

Cake Development Corporation 3 Apr 13, 2022
Hakkie is a social networking service on which users post and interact with messages

Hakkie Hakkie is a social networking service on which users post and interact with eachother with comments, likes, messages, blocks and silencing, ins

Felipe_Estevanatto 3 Sep 20, 2022
An attempt at a usable, generic VPS panel for providers and power users.

An attempt at a usable, generic VPS panel for providers and power users. Key goals are to be clean, easy to use, and support Proxmox as well as other providers (Libvirt via Go API, etc) using one simple interface.

null 1 Oct 3, 2022
Retrieve MySejahtera App's data from MySejahtera API and show to users via web browser. Written in PHP

MySejahtera-PHP-Web Retrieve MySejahtera App's data from MySejahtera API and show to users via web browser. Written in PHP. Disclaimer This web app is

Sam Sam 3 Oct 21, 2022
Laravel website prototype with backoffice for content and users management

LaraProto LaraProto is a Laravel website prototype with backoffice for content and users management. Just install and glue your front end views Based

Marco Afonso 7 Aug 26, 2016
A simple helpdesk tickets system for Laravel 5.1+ which integrates smoothly with Laravel default users and auth system

A simple helpdesk tickets system for Laravel 5.1+ which integrates smoothly with Laravel default users and auth system, demo is available at: http://ticketit.kordy.info/tickets

Ahmed Kordy 857 Dec 30, 2022
Instagram automation represents the use of third-party software to manage your account, carry out tasks and/or interact with users without a human present. Bulit in Laravel Framework

How to Deploy laravel project to heroku Video Link : https://youtu.be/7Nq_a2QiaHo Home Page Login Page Dashboard Page About Laravel Laravel is a web a

null 1 Dec 3, 2021
The platform allows you to manage articles, comments, tags, categories, and users for a blogging platform.

Laravel Blogging Platform The platform allows you to manage articles, comments, tags, categories, and users for a blogging platform. The project was w

Khaled Farhat 6 Oct 2, 2022
A free and open-source accounting and production system for businesses and non-profits with support for multiple users and varied integrations

A free and open-source accounting and production system for businesses and non-profits with support for multiple users and varied integrations.

null 3 Sep 22, 2022
Damn Vulnerable Web Application (DVWA) is a PHP/MySQL web application that is damn vulnerable.

Damn Vulnerable Web Application (DVWA) is a PHP/MySQL web application that is damn vulnerable. Its main goal is to be an aid for security professionals to test their skills and tools in a legal environment, help web developers better understand the processes of securing web applications and to aid both students & teachers to learn about web application security in a controlled class room environment.

Robin Wood 7k Jan 5, 2023
This application is a simple application to watch movies like Netflix or DisneyPlus.

Movie Streaming React Web Apps This application is a simple application to watch streaming movies like Netflix or DisneyPlus. The application is built

Adim 2 Sep 25, 2022
Centreon is a network, system and application monitoring tool. Centreon is the only AIOps Platform Providing Holistic Visibility to Complex IT Workflows from Cloud to Edge.

Centreon - IT and Application monitoring software Introduction Centreon is one of the most flexible and powerful monitoring softwares on the market;

Centreon 14 Dec 16, 2022
Emoncms is an open-source web application for processing, logging and visualising energy, temperature and other environmental data and is part of the OpenEnergyMonitor project.

Emoncms is an open-source web application for processing, logging and visualising energy, temperature and other environmental data and is part of the OpenEnergyMonitor project.

Emoncms 1.1k Dec 22, 2022
Mibew Messenger - open-source live support application written in PHP and MySQL

Mibew Messenger is an open-source live support application written in PHP and MySQL. It enables one-on-one chat assistance in real-time directly from your website.

Mibew Messenger 443 Dec 13, 2022
DinoPHP is a web application framework

DinoPHP is a web application framework with expressive. We believe development must be an enjoyable and creative experience. DinoPHP takes the pain out of development by easing common tasks used in many web projects

Ahmed Mohamed Ibrahim 24 Jan 1, 2023