AccessMyResearch

AccessMyResearch is a BootstrapVue + Vue.js web application designed to connect users with researchers, increase access to publications, & act as a space for teams to work on research-related projects.

Project Goals

AccessMyResearch aims to increase the accessibility of research to all people by allowing users to:

1. Create an account for free
2. Gain access to publications and research from academics from all over the world
3. Ask questions & discuss with experts from top universities
4. Organize inspiring publications into shareable, named collections
5. Develop projects with other users where the group's research can be uploaded

Getting Started

1. Set up a Development Environment
2. Set up Git
3. Clone the Repo & Install Project Dependencies
4. Set up Docker

Useful Commands

1. npm install - Installs all dependencies
2. npm ci - Removes all dependencies and installs them all cleanly
3. npm run build - Builds the code
4. npm run dev - Automatically builds all changes & runs the code locally/on network
5. npm test - Runs the code test suites (with Jest)
6. npm run serve - Serves the code (not going to be useful for a while)
7. npm run lint - Starts the Vue linter

AccessMyResearch Wiki

Contributing	Codebase
Using Git	Core Technologies & Dependencies
Getting Started	Containerized Virtualization with Docker
How to Contribute	Server Hosting by AWS
Project Files	Elasticsearch
Solving Common Issues	Testing with Jest

Important Notes

1. Comments indicating what needs to be done should begin with TODO:, so these comments can be easily searched for instead of getting buried and forgotten about.

   • In JavaScript: //TODO: Replace dummy data with entries from database
   • In HTML/Vue.js: <!--TODO: Replace dummy data -->

2. In Vue.js, don't specify the location of the src folder when importing, instead use the @ symbol. It dynamically points to the src folder of the Vue.js project.

3. Avoid creating new colors, fonts, or sizes. Check what theme colors you can use and other project styling globals at src/assets/custom/_variables.scss

4. Looking to implement a new component? First, check the src/components/ folder. It is always best to use the components that have already been properly implemented.

   Still need a new component? Check out BootstrapVue Components or Element Components.

5. Avoid adding redundant dependencies. See what each dependency does before you add a new one.

6. If you encounter an issue, check to see if there is a solution

   Be sure to document the solution to your problem if you think others might encounter it too.