Skip to content

Added README.md #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
psankhe28 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added README.md #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<h2 align="center">
<a href="http://camicroscope.org/"><img src="https://avatars2.githubusercontent.com/u/12075069?s=400&v=4" style="background-color:rgba(0,0,0,0);" height=230 alt="camicroscope: a web-based image viewer optimized for large bio-medical image data viewing"></a>
</h2>

caMicroscope is a web-based biomedical image and data viewer, with a strong emphasis on cancer pathology WSI (Whole Slide Imaging).
This guide has sections for different kinds of use of the platform. [Host Locally](#host-locally) covers how to set up caMicroscope locally. [Developer Guide](#developer-guide) covers the broad strokes on how to add new functionality to caMicroscope.

# Other Resources
- **Slack:** <http://bit.ly/camicroscope>
- **Discussion mailing list:** <https://groups.google.com/g/camicroscope>

# Developer Guide
caMicroscope is open source software. Any involvement and contribution with the caMicroscope project is greatly appreciated. Feel free to get directly involved in any of the repositories in the caMicroscope organization. New developers may find the notes in [CONTRIBUTING](https://github.com/camicroscope/caMicroscope/blob/master/CONTRIBUTING.md) helpful to start contributing to caMicroscope.

## Host Locally
Follow these steps to host this locally:
- Clone [this](https://github.com/camicroscope/camicroscope.github.io) repository.
- Open the clone folder in any text editor.
- You need to create a local server to view your HTML, CSS, and JS files.
```
- You can use a tool like Live Server for this purpose.
- Open your text editor's terminal or command prompt.
- Navigate to your project directory.
- Install Live Server by running the command: npm install -g live-server.
- If using VSCode, click on the extensions option available on the left side and install live server extension.
- Run Live Server by typing live-server in the terminal.
```
- Once you've started the local server, you can view the project in your web browser by going to http://localhost:8080/ or any other port specified by the Live Server.

That's it! You should now be able to see your project locally.