Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xnought authored Nov 12, 2023
1 parent 6500131 commit b40d43c
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,18 @@

![Github Actions CI tests](https://github.com/xnought/venome/actions/workflows/ci.yml/badge.svg)

A wikipedia 📖 for proteins.
A wikipedia 📖 for venom proteins: upload, search, organize, visualize, and download protein files all open source.

🤝 In collaboration with the 🧪[Venom Biochemistry & Molecular Biology Laboratory](https://venombiochemistrylab.weebly.com/) at Oregon State University 🦫.

## Structure

- [`docker-compose.yml`](./docker-compose.yml) contains the Docker container build
- [`frontend`](./frontend/README.md) contains the user interface in Svelte/JS
- [`backend`](./backend/README.md) contains the HTTP server and Database

> **Important**
> Directories and files you'll need to know about
> - [`frontend/`](./frontend/README.md) contains the user interface in Svelte/TypeScript
> - [`backend/`](./backend/README.md) contains the backend HTTP server and Database
> - [`docs/`](./docs/README.md) contains code documention
> - [`DEVELOPMENT.md`](./docs/DEVELOPMENT.md) contains the developer getting started docs
> - [`docker-compose.yml`](./docker-compose.yml) contains the Docker container build
> - [`run.sh`](./run.sh) contains shortcut commands to develop, deploy, and test
## Quick start

Expand All @@ -22,3 +24,7 @@ Go to [`DEVELOPMENT.md`](./DEVELOPMENT.md) to get up and running.
- [Design Space (Figma)](https://www.figma.com/file/G1pbQsYy4lCTVCvMEnGydX/Unknown-Venome-Project?type=design&node-id=0%3A1&mode=design&t=re8tfITwMPw75A2I-1)
- [Whiteboard (Figma Jam)](https://www.figma.com/file/ZKwrwzXrbwqMJUTFPF4yV0/Open-Venome-Project?type=whiteboard&node-id=0%3A1&t=DZbia2Quj2IXPhHm-1)
- [Protein BioChem](<https://bio.libretexts.org/Bookshelves/Biochemistry/Book%3A_Biochemistry_Free_For_All_(Ahern_Rajagopal_and_Tan)/02%3A_Structure_and_Function/203%3A_Structure__Function-_Proteins_I>)
- [SvelteKit](https://kit.svelte.dev/)
- [Svelte](https://svelte.dev/)
- [FastAPI](https://fastapi.tiangolo.com/)

0 comments on commit b40d43c

Please sign in to comment.