Files
Sebastiaan Janssen d673877e4e Update README.md
2017-03-31 14:47:44 +02:00

54 lines
2.7 KiB
Markdown

Our Umbraco
==========
Complete source of the umbraco community site, our.umbraco.org.
## Build in visual studio
Make sure to allow NuGet Package Restore in VS (Tools > Options > Package Manager). The first buid of the project will take quite a while, be patient, it will finish at some point.
Upon build a web.config file will be copied into the `OurUmbraco.Site` project which you can use in the following step.
If you're working on the frontend (the js/css/etc parts in `~/OurUmbraco.Client`) then you can either run `~/build/BuildClientFiles.bat` to build them and have them copied into the site or `~/build/RunGulp.bat` if you're actively working (gulp will monitor changes, build and copy). Or if you have npm/gulp installed on your machine you can run the usual commands in the `~/OurUmbraco.Client` folder:
```
npm install
npm install -g install gulp -g
gulp
```
## Database restore
Download the SQL Server Database from: http://umbracoreleases.blob.core.windows.net/ourumbraco/OurDev.zip
Restore the database to SQL Server 2012 SP2 (won't work on earlier version) and update the connection strings (`umbracoDbDSN`) in `OurUmbraco.Site/web.config`.
## Logging in
All users and members use the same password: Not_A_Real_Password
To log in, try `root` / `Not_A_Real_Password` for the backoffice and `member423@non-existing-mail-provider.none` / `Not_A_Real_Password` for the frontend.
## Projects Area
If the projects area seems empty then that's because you need to rebuild the Examine indexes for it through the Developer section of Umbraco
## Documentation area
If the documentation area seems empty then that's because you need to download the documentation, look for the `documentationIndexer` in the Examine dashboard in the Developer section of Umbraco and Rebuild the index. This will automatically download the latest documentation from github.
## Syncing your fork with the original repository
To sync your fork with this original one, you'll have to add the upstream url once:
git remote add upstream git://github.com/umbraco/OurUmbraco.git
And then each time you want to get the changes:
git fetch upstream
git rebase upstream/master
Yes, this is a scary command line operation, don't you love it?! :-D
(More info on how this works: http://robots.thoughtbot.com/post/5133345960/keeping-a-git-fork-updated)
## Issues
If you're creating a pull request, make sure that it's backed by an issue on the tracker: http://issues.umbraco.org/issues?q=project%3A+our.umbraco.org
Mention the issue number in your pull request so we can merge it in more easily.
Even if you're not planning on sending a pull request, you can always create an issue on the tracker if it doesn't exist yet, it helps other find ways to contribute.