Skip to content
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

Jump to bottom

Doc Improvement on Dev Guidance and Build Process Trouble Shooting #2357

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

Doc Improvement on Dev Guidance and Build Process Trouble Shooting #2357

Show file tree
Hide file tree
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@ To help make improvements to this project, you can just clone this repository an

Before jumping in, please review the solution architecture and instructions below to [get started](#solution-architecture).

Please follow the [Development Guide](https://github.com/HTBox/allReady/blob/master/docs/prerequisite_install_guide/prerequisite_install_guide.md) to setup your development environment and build the project for launch and testing.

As of this writing (week of 7/20/2015), we are focused on expanding and filling out our documentation, issues lists, milestones plan and supporting any issues that arise from community engagement with the codebase. Additionally, you willl find issues of all types (simple bugs, new feature & requirements and architectural updates) upon which you can contribute to the project. In the meantime, if you find any issues with the codebase or other content in our repository please log an issue and we will work with you to solve it.

Thank you for considering supporting this open source project for humanitarian support.

## Solution architecture

See the [Solution Architecture Guide](https://github.com/HTBox/allReady/wiki/Solution-architecture) for all of the details on how allReady is built.
See the [Solution Architecture Guide](https://github.com/HTBox/allReady/wiki/Solution-architecture) for all of the details on how allReady is constructed, built, and tested.
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,6 @@ To help make improvements to this project, you can just clone this repository an

> **Important** Before jumping in, please review the [solution architecture](https://github.com/HTBox/allReady/wiki/Solution-architecture) and instructions below to [get started](https://github.com/HTBox/allReady/wiki/Solution-architecture#get-started-with-the-allready-solution). It contains critical information on how to configure the project to run locally and optionally deploy AllReady to Azure.

Also we have a guide on setting up git for open source projects like allReady that can help you get started making contributions. You can find the [guide in our docs folder](https://github.com/HTBox/allReady/blob/master/docs/git/gitprocess.md) and it also reference a number of blog posts written with additional information on contributing to projects like ours.
Also we have a [contribution guide](https://github.com/HTBox/allReady/blob/master/CONTRIBUTING.md) on setting up git for open source projects like allReady that can help you get started making contributions. You can find the [guide in our docs folder](https://github.com/HTBox/allReady/blob/master/docs/git/gitprocess.md) and it also reference a number of blog posts written with additional information on contributing to projects like ours.

Thank you for considering supporting this open source project for humanitarian support.
Binary file added docs/prerequisite_install_guide/images/web-11-manual-restore.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/prerequisite_install_guide/prerequisite_install_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,6 +468,13 @@ It may take a few minutes to compile the solution the first time.

If all has went well your solution compiled successfully and you are ready to run the web site.

**Trouble Shooting**
Sometimes the package dependencies will not be automatically restored by the Visual Studio at your first build attempt, and this could trigger the build process to fail with lots of error messages, basically claiming that certain dependent files could not be located. If you have run into this issue, you will need to manually restore the dependency packages.

To do this, go to Visual Studio's `Solution Explore`, expand the `Web` folder under the solution, then click the small triangle by the `Dependencies` to pen the dependency items tree, locate the `npm` entry, right click the entry, and click the `Restore Packages` from the context menu. This will launch the packages restoration process. After the status bar denote that the installations are complete, you can now build the solution again.

![Manually Restore the Dependency Packages](image/web-11-manual-restore.png)

### Running The Web Site

By default the Web project is set as the Startup Project. You can verify this in Solution Explorer by looking at the Web\AllReady project and seeing that it is bolded.
Expand Down