Getting Started

Setting up a Development Environment

VS Code is definitely the best IDE to use when developing a Vue.js/JavaScript application. I highly recommend installing it as a first step. Once you've done that, there are a variety of extensions for VS Code you can explore. For this project, I highly recommend downloading the following extensions:

• npm by egamma - For integration with Node.js
• Vetur by Pine Wu - For integration with Vue.js
• Prettier - Code formatter by Prettier - For code formatting (optional)

Just set up VS Code now? Learn how to use Git with VS Code here

Getting Started in the CLI

1. Clone the code from the github repo: https://github.com/AccessMyResearch/AccessMyResearch.git

   Find out how to clone the repo here.

2. From the AccessMyResearch (root) directory, run npm install

3. Run npm install @vue/cli -g to install the Vue CLI

4. Finally, run npm run dev to build and test the code

Once The dependencies are installed, you just need to run npm run dev when you want to build and test the code

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

Getting Started with Docker

1. You'll need to install docker (Windows, macOS, Linux)

2. Run docker-compose up -d --build from the base directory containing the dockerfile file

   Now, you should be able to access the web app at 127.0.0.1:8080.

   Check docker ps to see it running!

What's Next?

1. How to Contribute
2. Project Files
3. Core Technologies & Dependencies
4. Containerized Virtualization with Docker
5. Server Hosting by AWS
6. Elasticsearch
7. Testing with Jest
8. Solving Common Issues