Skip to content

Commit

Permalink
😎
Browse files Browse the repository at this point in the history
  • Loading branch information
Nasicus committed Jun 21, 2018
0 parents commit 17839d0
Show file tree
Hide file tree
Showing 47 changed files with 21,623 additions and 0 deletions.
131 changes: 131 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Created by https://www.gitignore.io

server/dist
client/build

### Node ###
# Logs
logs
*.log

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules


### WebStorm ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm

*.iml

## Directory-based project format:
.idea/
# if you remove the above rule, at least ignore the following:

# User-specific stuff:
# .idea/workspace.xml
# .idea/tasks.xml
# .idea/dictionaries

# Sensitive or high-churn files:
# .idea/dataSources.ids
# .idea/dataSources.xml
# .idea/sqlDataSources.xml
# .idea/dynamic.xml
# .idea/uiDesigner.xml

# Gradle:
# .idea/gradle.xml
# .idea/libraries

# Mongo Explorer plugin:
# .idea/mongoSettings.xml

## File-based project format:
*.ipr
*.iws

## Plugin-specific files:

# IntelliJ
/out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties


### Bower ###
bower_components
.bower-cache
.bower-registry
.bower-tmp


### Sass ###
.sass-cache
*.css.map


### OSX ###
.DS_Store
.AppleDouble
.LSOverride

# Icon must end with two \r
Icon


# Thumbnails
._*

# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns

# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk


### Vim ###
[._]*.s[a-w][a-z]
[._]s[a-w][a-z]
*.un~
Session.vim
.netrwhist
*~
67 changes: 67 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Diablo II - Holy Grail

The challenge to collect all Unique & Set items in "Diablo II - Lord of Destruction" is called the "Holy Grail".

Therefore this simple app allows you to track all found items from your Diablo II gaming experience.

Additionally it offers nice statistics of your found items and you can easily share your Holy Grail with your friends!

## Features

- Very fast & simple way to create a new Holy Grail
- Track all Unique & Set Items
- An on-type search quickly let's you find whatever you're looking for
- Share your own Holy Grail with friends in a read-only mode

![Sample image of the app](./sample.png)

## Contribute

If you want to contribute feel free to create [pull request](https://github.com/Nasicus/d2-holy-grail/pulls) or to create [issues](https://github.com/Nasicus/d2-holy-grail/issues) for new features or problems!

### Developing

The app basically consists of two parts, which both can run completely apart from each other.

#### server directory

Contains the server app which is written with Typescript, NodeJs and MongoDB.

Once started, the server will run under http://localhost:5000

#### client directory

Contains the client app which is written with TypeScript & React.

Once started, the app will run under http://localhost:3000

The client app gets its data from the server app, which means if you want to be able to retrieve data and save it to the server you have to run the server app.

#### Prerequisites

- [Node JS](https://nodejs.org) (with `npm`)
- An installed and running instance of [Mongo DB](https://docs.mongodb.com/manual/administration/install-community/)

#### Initial Setup

Once you have checked out this repository you have to execute the following command in the `root`, the `client` and the `server` directories:

```
npm install
```

#### Development Steps

Whenever you'd like to develop you have to execute the following command in the the `client` and the `server` directories:

```
npm run dev
```

By running this command you should be good to go and by accessing the client app URL you should be able to test and use the app!

Alternatively you can also start both - the `client` and the `server` - at once, by executing the following command in the `root` directory:

```
npm run dev
```
Loading

0 comments on commit 17839d0

Please sign in to comment.