devlead/corewiki repository overview

⁠CoreWiki

A simple ASP.NET Core wiki that we are working on during live coding streams. It runs on Windows, Mac, Linux and Container. Core Wiki is an allusion to the Core App. This name was suggested by Shayne Boyer in the stream of the 27th/March⁠. Initially this project is very basic and anyone who is learning ASP.NET Core 2.0 (Razor Pages) can use it to learn.

To learn more about Jeff's stream check his Live Stream Repository⁠.

⁠Table of contents

• Getting Started⁠
  • Live Demo⁠
  • Local Development⁠
  • Deploy own instance⁠
  • FAQ⁠
    • How do I get rid of the 'default administrator enabled' warning?⁠
• Features⁠
• Continuous Integration with Azure Pipelines⁠
• Streams Archive⁠

⁠Getting Started⁠

⁠Live Demo⁠

Explore a CoreWiki live demo at https://corewiki.info/⁠

⁠Local Development⁠

To run the latest version of CoreWiki on your local dev machine, open your favorite terminal on an operating system of your choice, and execute the following:

git clone https://github.com/csharpfritz/CoreWiki.git
cd CoreWiki\CoreWiki
npm install
dotnet run

:bulb: Tips: you can also use the watch command, it will rebuild CoreWiki when you do any code change dotnet watch run

⁠Deploy own instance⁠

Fastest way to ship your own instance is to try our Deploy to Azure button, but you can deploy to a cloud provider of your choice.

⁠FAQ

⁠I want to contribute:

@csharpfritz is inviting for new and old to learn together with team stream, and make a pull request. A more descriptive contributing guide is written here: contributing⁠

• To find task that has been discussed, search in the issues for help-wanted here⁠
• If you see TODO in code, or see small improvements in current functionality, you are also welcome to make a pull-request
• If you want to try adding a new feature, please open an issue so @csharpfritz can review the idea

⁠How do I get rid of the 'default administrator enabled' warning?⁠

You shouldn't see this problem any longer, as the latest versions of CoreWiki now include an initial start wizard that allows you to create a default administrator user. If you are using an older version of CoreWiki, follow these steps:

1. Register a new account (it won't have administrator rights for obvious reasons).
2. Sign in as the default administrator (username: [email protected]⁠, password: Admin@123), and go to the User Admin page from the main menu up top.
3. Scroll down, find the user you just registered, and give them the administrator role.
4. From the main menu again, click the email address near the Logout button to open the profile manager.
5. Click on the Personal Data sub-menu, and delete this default admin account.

⁠Features⁠

HomePage - It's not a page or a feature. This is a default article that is presented as if it were the Home. When the user navigate to /Details, if topicName is not specified, the application redirect to default Article (HomePage)

⁠Header Menu

• Allows the users navigate to the Default article (HomePage). [Back to Home (CoreWiki)]
• Allows the users navigate to LatestChanges articles feature.[LatestChanges]
• Allows the users navigate to Create new article feature. [Create new article]
• Allows the users navigate to All articles feature. [All]

⁠Details

• Allows the users see details of article.
• Allows the users navigate to Edit feature. [Edit]
• Allows the users navigate to the Default Article (HomePage). [Back to Home]
• Allows the users see comments list
• Allows the users add new comment[New Comment]

⁠Create

• Allows the users create a new article. When success, redirect the user to Details Feature. Otherwise, stay in the page and show error message. [Create]
• Allows the users to navigate to the default article (HomePage). [Back to Home]

⁠Edit

• Allows the users change the article (Topic, Published and Content).
• Allows the users navigate to the default article (HomePage). [Back to Home]

⁠Delete

• Allows the users delete the article (Topic, Published and Content).
• Allows the users navigate to the default article (HomePage). [Back to Home]

⁠LatestChanges

• Allows the users see the last 10 articles. Ordered by Published Date.
• Allows the users navigate to Edit feature. [Edit]
• Allows the users navigate to Delete feature. [Delete]
• Allows the users navigate to Details feature. [Detail]
• Allows the users navigate to Create new article feature. [New article]
• Allows the users navigate to the default article (HomePage).[Back to Home]

⁠List All

• Allows the users see ALL articles. Ordered by Topic.
• Allows the users navigate to Edit feature. [Edit]
• Allows the users navigate to Delete feature. [Delete]
• Allows the users navigate to Details feature. [Detail]
• Allows the users navigate to Create new article feature. [New article]
• Allows the users navigate to the default article (HomePage).[Back to Home]
• Allows the users navigate to Latest Changes feature. [Latest Changes]

⁠Search engine friendly URL's

[Description]

⁠NotFound

• Occurs, always which an page is not found.

⁠Error

• When an exception occur, o user is redirected to error page. [Not Simulated].

⁠Continuous Integration with Azure Pipelines⁠

CoreWiki is built and tested continuously by Azure Pipelines. Shortly after you submit a pull request you can check the build status notification. All contributions encouraged!

⁠Streams Archive⁠

Archive of all shows from the stream can be found on Jeff's YouTube 'Building the CoreWiki'⁠ playlist.

⁠Recordings Index