This is the repository for the BioGRID Annotation and Curation Engine (ACE) a tool for handling literature curation tasks and managing annotation resources required to complete those tasks.
- IN PROGRESS
- Version: 0.0.4 ALPHA
- State: Unstable
- GIT 2.23+ (https://git-scm.com/download)
- Node.js 10.16.3+ (https://nodejs.org/en/)
To launch the application, you must generate a .env file in the root folder and enter the following variables
- NUXT_ENV_APP_TITLE_SHORT (a short name for the app. Ex.
BioGRID ACE
) - NUXT_ENV_APP_TITLE_LONG (a longer name for the app. Ex.
BioGRID Annotation and Curation Engine
)
To use this application, you must register a new Firebase application. After completing registration, you must fill out these corresponding environment variables in your .env file.
- NUXT_ENV_FIREBASE_API_KEY
- NUXT_ENV_FIREBASE_AUTH_DOMAIN
- NUXT_ENV_FIREBASE_PROJECT_ID
- NUXT_ENV_FIREBASE_STORAGE_BUCKET
- NUXT_ENV_FIREBASE_MESSAGE_SENDING_ID
- NUXT_ENV_FIREBASE_APP_ID
If you want to have the username and password fields filled in by default, set the following two environment variables. Useful for development environments requiring constant login and logout.
- NUXT_ENV_LOGIN_DEFAULT (optional)
- NUXT_ENV_PASSWORD_DEFAULT (optional)
- Manually install all of the requirements listed above
- Create a directory for development
- Clone this repository
git clone https://github.com/BioGRID/BioGRID-Ace.git
or you can download it directly and extract it locally - Create ENVIRONMENT files as specified above
- Run
npm install
to install all dependencies - Run
npm run dev
to serve a development version of the site with hot reload capabilities located atlocalhost:3000
- Run
npm run build
to build for production - Run
npm run start
to launch node.js and serve the production version of the application.
- To utilize this application, you must setup and configure firebase for authentication.
- Make sure you have a firebase account: https://firebase.google.com/
- Enable firebase authentication and the
email/password
authentication option - Enable firebase functions (this requires swapping from the free to
pay-as-you-go
option, but limits are still very high before costs) - Enter all firebase configuration settings for your application in the
.env
file as specified above - Download and install firebase-tools
npm install firebase-tools -g
- Run:
firebase login
and proceed with the login confirmation - From the
biogrid-ace
directory, runfirebase deploy --only functions
to deploy the required cloud functions - Proceed to setup initial new users for the system
This application contains tests that you can run to check the stability of the application building in new features.
- To run the tests, from the root enter
npm run test