spongepowered / ore Goto Github PK

Repository software for Sponge plugins and Forge mods

Home Page: https://ore.spongepowered.org/

License: MIT License

Scala 55.02% HTML 20.38% CSS 0.08% JavaScript 14.04% Java 0.03% Python 0.47% PLpgSQL 6.03% Batchfile 0.01% Shell 0.01% Vue 1.97% SCSS 1.98%

sponge sponge-plugin sbt scala minecraft jvm hacktoberfest

ore's Introduction

Ore

Repository software for Sponge plugins and Forge mods https://ore.spongepowered.org/

Ore is written in Scala using the Play framework.

Clone

The following steps will ensure your project is cloned properly.

git clone https://github.com/SpongePowered/Ore.git
cp scripts/pre-commit .git/hooks

Setup

After cloning Ore, the first thing you will want to do is create a new PostgreSQL 11 database for the application to use. This is required in order for Ore to run. Learn more about PostgreSQL here.

You will also need to enable a few extensions for Ore. These are:

In addition, you need to install Node.js and Yarn. Installation instructions are available for Node.js and Yarn.

After setting up a database, create a copy of application.conf.template named application.conf and configure the application, for the application you want to run. This file is in the .gitignore so it will not appear in your commits. Your local copy needs to get updated every time you pull changes, which add a new setting to the config. Currently valid applications are ore and jobs, and their configuration files can be found in ore/conf/application.conf.template and jobs/src/main/resources/application.conf.template.

In a typical development environment, most of the defaults are fine. Here are a few you might want to take a look at though.

For ore:

You can disable authentication by setting application.fakeUser to true.

Running

Running Ore is relatively simple.

With SBT

Download and install the latest SBT version.
Execute sbt ore/run in the project root to run the web app.
Execute sbt jobs/run in the project root to run the jobs processing.
Note: You are advised to keep the sbt shell open when doing development instead of starting it for each task.

With IntelliJ Community Edition

Install the Scala plugin.
Import the build.sbt file.

For ore:

Create a new SBT Task run configuration. Enter ore/run in the Tasks field.
Untick the box that says Use sbt shell
Run it.

For jobs:

Either repeat the process for ore, but use jobs/run instead of ore/run.
Or, click the green triangle next to OreJobProcessorMain when opening up the file.

Note: You might encounter a stack overflow exception when compiling ore. This is not unexpected. Just assign more stack size to sbt in the way you're starting sbt. -Xss4m should be enough. If you're using IntelliJ, you can set this in the VM arguments field. If you're invoking sbt directly, the most common ways to set this is either through the SBT_OPTS environment variable, or with a file named .jvmopts with each flag on a new line.

ore's People

Stargazers

Watchers

ore's Issues

Footer

Site needs a footer. Please discuss what you think it should contain here.

Logging in should redirect to previous page

Minor, but if I'm looking at a page for a plugin, and I decide to login, I should be redirected to that plugin's page, rather than back to the main page.

Discussion threads are going into wrong spot on Forums

@windy1

We have: https://forums.spongepowered.org/c/plugins/ore
and: https://forums.spongepowered.org/c/plugins/ore-topics

You're putting the projects into the latter area. I'd just have @Owexz to remove everything in the ore section and you put your stuff in there. Obviously this isn't the final area these would go.

TODO: Frontend

File upload offloading

Once uploaded, files should be kept locally for a short time before being offloaded to repo.spongepowered.org.

This means you need:

small background task which waits for new files and periodically attempts to upload them over FTP (make background tasks separate to the webserver, please, I don't want multiple instances of webserver == dozens of copies of background task, that makes me 😭)
ability to redirect to signed URL (signing algorithm TBD, it'll just be Yet Another Secret + timestamp)
need to be able to differentiate between currently-locally-stored files and uploaded-to-repo files (if you want to serve immediately - alternate approach is that you just bite the bullet and don't display it to people until it's been uploaded, which works equally well)

Support emojis

Include support for emojis, as seen on the Sponge Forums.

Finalize the navbar with the sister pages

@windy1

I promise, this is the last of these :).

Docs:

Ore:

Drop down icon is different. Position is correct I think

Renaming a project doesn't rename the corresponding discussion thread

@windy1

Looks like you are creating a new forum thread instead. Need to get this resolved.

[WIP] API Specification

This Issue is to work on defining the API specification for Ore API v1 either in the main Ore implementation or in Pore. Pinging @lukegb

`GET /api/projects/`

[
    {
        "id": "<project_id>",
        "name": "<project_name>",
        "description": "<project_description>",
        "owner": "<project_owner>",
        "developers": [ "Spongie", "Dev1", "Dev2", "Dev3" ],
        "teams": [ "SpongePowered", "Team1" ],
        "channels": [ "Alpha", "Beta", "Release" ],
        "recommended": "<download_link>"
    }
    ...
]

`GET /api/users/:user/`

{
    "name": "<user_name>",
    "type": "<dev|team>",
    "starred": "<starred>",
    "teams": [ "SpongePowered", "Team1", "Team2", "Team3" ],
    "projects": [ "Plugin1", "Plugin2", "Plugin3" ]
}

`GET /api/projects/:owner/:name/`

{
    "id": "<project_id>",
    "name": "<project_name>",
    "description": "<project_description>",
    "owner": "<project_owner>",
    "developers": [ "Spongie", "User1" ],
    "teams": [ "SpongePowered", "Team1" ],
    "channels": [ "Alpha", "Beta", "Release" ],
    "recommended": "<download_ref>"
}

`GET /api/projects/:owner/:name/channels/:channel/`

[
    {
        "version": "1.0.0",
        "description": "<version_description>",
        "url": "<download_ref>"
    }
    ...
]

More...

Restrict image width

Image width can get a little out of hand when viewing a project. See an example here

"More" button shows up always (even if un-needed)

The more button should be smart about showing up. Right now it shows even if a category has no projects.

As for showing up with projects, set a decent amount of projects before seeing it...whichever wouldn't tax the backend too much (20?)

Discussion threads are only visible to the Sponge team

It appears that the discussion threads are only available to the Sponge team. Ore gets a 403 Forbidden error whenever trying to load them for me. I'm not sure if this is intended or not.

API Key for developers / teams

We should consider some sort of API secret so SpongeGradle can have a release task that uploads the latest version. But possible security issues?

.

Aha! Finally saw the 502 Page (It needs to be updated)

http://imgur.com/2O7vUmK

When your commit you just made @windy1 caused the staging to refresh, I was met with the above page...we should get this updated.

@lukegb ?

Display more information on downloads page

http://imgur.com/vOwxC9H

Instead of displaying an "i" to click for more information, lets take advantage of the space we have and display relevant details in a grid view much like the main page

We should have:

Version - Date - Download Size - Channel - Download button

Discuss!

Make consistent the widths between projects/categories on Home

http://imgur.com/8ZNj5B4

Couple of things to note:

The thickness of the bar under "Categories" (cut off at the top right) doesn't match the left
Once the above is fixed, the lines should line up between the left grid view and the right grid view

Sentry support

Please support https://getsentry.com for error reporting, we have an account. Poke me on IRC for details.

Discuss Page Discussion and Requirements

So thinking forward to the Discuss page, following are my requirements:

Embed Discourse discussions into the project page
Create thread on forums for Ore project but un-list it. May not be desirable with the below.
@windy1 discovered that Discourse doesn't provide a "reply" box for embedded discussions. We'll need to create one for Ore's purposes
You'll get notifications on the forums for replies to the Ore thread. You can comment on the forums to that thread and those replies end up on the Ore discuss page. A good example is what Neowin does at www.neowin.net where the main site pages comments are just forum posts on a forum thread in the background. This doesn't mean you can't comment on the Ore discuss page. Just two avenues of approach.
The generated forum post should ONLY have a link to the Ore thread. This one should be discussed further, my Neowin example puts the main post content into the forum thread OP but trims it some.

Any more thoughts or opinions? Post them here...the discuss page is a big part of Ore and a requirement before beta status.

ZIP Validation

How exactly does ZIP files get handled during the project creation process? If I have a zip file with three jars, is it declined or is the first it finds used?

TODO: v1.0.0-BETA

Official Ore Backend TODO List

Coordinate navbar sizing and widget positioning with Forums page

Now that we've got the widths where we want them we should get @Owexz here to coordinate making his navbar the same size as Ore's and position the Sponge logo and Avatar widgets to be at the same positioning.

This will really help sell to people that Ore is a part of our web services and not a separate component.

Finish setting up Docker container

This needs to happen - most of the work is just trying to figure out how to feed you data.

Support github-flavored markdown

I know this was on your TODO @windy1 but this issue will serve as a reminder.

Project owners should not be able to star their own projects

Hahaha...no.

Tsk @windy1 !

Duplicate Uploads

We shouldn't allow people to add new versions with files that have the same md5 as past versions.

Make avatar be a rounded rectangle to match style

The avatar currently looks a bit off. We should have it match the rounded rectangle of the Spongie logo.

Establish color template across Ore

Maybe it is just me but even if yellow is our brand coloring, I have issues with reading the words that are yellow...they bleed together and I tend to have to re-read some names to make sure I'm reading this right.

This would be fixed if Ore had a black theme (YES YES YES YES YES YES) and the yellow on the black would be so so sexy but if we want to keep the light theme then we should consider different shades of yellow.

@tzk , maybe you could help too?

Version assets

Versioning assets will eliminate caching issues - #11 (comment).

http://webassets.readthedocs.org/en/latest/expiring.html

Weird Ore Error

This happens when I uploads a forge mod.

Project name regex

We need to come up with a regular expression for allowed project / channel / version names. Currently anything is permitted.

Treat column headers on main page as toggles for ascending/descending

Basically think Excel and if you click a header, it'll sort by ascending and then clicking again goes descending.

Sort by download counts first or starred? May need discussion on that one.

Terms of Service

We need to write up a "terms of service" for Ore as sort of a disclaimer so we aren't held responsible if someone downloads a plugin that blows up their server.

IANAL.

Disallow spaces in project names (or have separate slugs)

Spaces don't translate well to URLs (%20 everywhere), so if you're going to allow them in project names we need slugs which are different (and are separately deduplicated)

Alternatively, just don't allow spaces in project names, and push people to using - and _ instead (potentially automatically replacing spaces with - like GitHub itself does)

Incorrect avatar used

I use a custom avatar image on the forums and Ore seems to generically use gravatar. May want to try and use whatever is in use on the forum.

Member since on user page doesn't use forums join date?

@windy1

This isn't an issue but more a question. Do we want the date joined to be your join date of the forums or the join date you first logged into Ore?

My avatar is missing...?

On the Sponge forums, my avatar shows my Minecraft skin (same as my GitHub avatar, but round). On Ore, it uses the default Gravatar icon. Could someone fix this?

It seems to happen with other Ore accounts as well, but not all. I'm not sure what the cause is.

Specify namespace on project creation (for repository resolution)

The intention is for Ore plugin uploads to hit repo.spongepowered.org and, eventually, be able to be pulled from maven just like a project on Maven Central/etc. For this to work out, we need that namespace and for it to be concrete. Relying on a fully qualified id from the plugin id isn't acceptable (and frankly may be removed soon).

Encourage any and all discussion on the matter.

Users with longer names do not fit in the user dropdown

The max length on the forums for usernames is around 20 or so, so ore should probably support that at least.

Provide means of returning back to Ore home

Unless I'm completely missing it, when I'm clicked onto a Project's space I see no good way to go back to Ore's main page.

Alphabetize the category list in all areas

Main page, project creation, settings of a project need it. Makes it easier to look at. :p

Localization

Play can be localized through the Messages API. Currently there's a mix of string constants defined in the conf/messages.en-US file and in plain HTML mostly cause lazy but Ore can be localized by creating new files with language code extensions (conf/messages.fr).

Most strings in the views should be moved to language files.

Logging into Ore fails

Whenever I press the login button on Ore site, there is an exception in the code. The exception id is 6pkocd6b9. I am logged in on the forums when I try to login to Ore, so that is not the cause.

Project Submission Changes

So I played around with adding a new project and want the following adjusted:

After you choose a file, either upload it automatically or give me some status of what I've chosen (jar name and file size). Right now I actually waited a sec for some feedback before realizing I need to hit "upload".
There is no need for the two step process to be constrained to a small rectangle box. Make it a bit bigger so it stands out more
This coincides with my other issue about selecting categories and how that shows to the end user but plugins should be able to classify themselves as multiple categories. Set a limit on it if you wish (up to 5?)

Sizing of navbar

I feel the navbar is a bit too thick and cuts into the site content a bit much than necessary.

Specify source and issues

There are Docs, Versions, and Discuss tabs on projects right now, and it would be nice to be able to configure (in project settings, not just at creation time) optional links to a Source repository and to an Issues manager.

Previewing changes in editing a Page does not function

https://ore-staging.spongepowered.org/Zidane/Test

Have Ore adhere to responsive UI

Noticing this across the product but how Ore displays its products and pages could benefit greatly by making use of the space available to the browser. Any way to do this without breaking mobile support?

Page rendering inconsistences between Github and Ore

@windy1

Unsure if this is github doing it elsewhere but:

Github:

Ore:

You should see the differences here. Very nice on the support!

Revise display of selected categories/channels

After looking at the categories/channels selections, I feel that the better solution would have them be colored when selected (colored label) and uncolored when not. Much better than clicking a little eye :).

spongepowered / ore Goto Github PK

ore's Introduction

Ore

Clone

Setup

Running

ore's People

Stargazers

Watchers

Forkers

ore's Issues

GET /api/projects/

GET /api/users/:user/

GET /api/projects/:owner/:name/

GET /api/projects/:owner/:name/channels/:channel/

Official Ore Backend TODO List

Recommend Projects

Recommend Topics

Recommend Org

`GET /api/projects/`

`GET /api/users/:user/`

`GET /api/projects/:owner/:name/`

`GET /api/projects/:owner/:name/channels/:channel/`