AMUI

Additive Manufacturing User Interface (AMUI)

Quickstart

1. Clone the repository with your prefered method.

   git clone [email protected]:BaratiLab/AMUI.git

2. Follow the instructions for downloading and installing Docker Desktop
   • Make sure the docker compose works here, you'll need it for this project.
   • Creating an account is optional here.
3. Open AMUI project in VSCode
4. Duplicate .env.example file and rename to .env.
   • Fill in the following empty fields (ask @ppak10 if you need help).
5. Open terminal and (under AMUI directory) start containers.

   docker-compose up -d

6. Follow further instructions for either api or web

Contributing

Perform these commands inside a terminal not attached to Docker container.

1. Create new branch on GitHub for your feature off of the main branch.
   • Provide the new branch with a descriptive feature title like: README-troubleshooting-updates.

2. Pull newly created branch locally. ```bash git pull ``` - You see that new branch now

  ![image/new_branch_pull.png](./images/new_branch_pull.png)

3. Change to this local branch.

   git checkout <REPLACE-WITH-BRANCH-NAME> 

4. Make your changes and stage them for commit.

   git add .

   • This will add all changes.

   • Make sure to follow additional instructions for api or web

   • git status will show your staged changes in green.

     

5. Commit your changes with a descriptive commit message.

   git commit -m "Your 80 character maximum commit message goes here"

   

6. Push your changes to GitHub.

   git push

   

7. Go back to repository on GitHub and create a Pull Request

   • You should see a banner notification about your latest change.

   • Click on the "Compare & pull request" button to create a Pull Request

     

   • Add @ppak10 as reviewer and fill in other the necessary details.

     

8. Delete feature branch once pull request is merged

9. Pull and Checkout main branch locally

   git pull
   git checkout main

Notes

• PGAdmin
  • Host name/address: amui-sql
  • Username: postgres
  • Password: check POSTGRES_PASSWORD in .env
• Docker
  • Delete Docker Images: docker rmi -f $(docker images -aq)
  • Enter Docker Container: docker exec -it [container-id] bash
  • Delete Docker Volumes: docker volume rm $(docker volume ls -qf dangling=true)

Troubleshooting

• Need sudo on Docker in Ubuntu