Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
funkwhale
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Zwordi
funkwhale
Commits
6c066881
Verified
Commit
6c066881
authored
6 years ago
by
Eliot Berriot
Browse files
Options
Downloads
Patches
Plain Diff
See #327: changelog and easier contribution documentation
parent
690bc47f
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
CONTRIBUTING
+36
-0
36 additions, 0 deletions
CONTRIBUTING
changes/changelog.d/327.feature
+22
-0
22 additions, 0 deletions
changes/changelog.d/327.feature
with
58 additions
and
0 deletions
CONTRIBUTING
+
36
−
0
View file @
6c066881
...
...
@@ -12,6 +12,42 @@ This document will guide you through common operations such as:
- Writing unit tests to validate your work
- Submit your work
A quick path to contribute on the front-end
-------------------------------------------
The next sections of this document include a full installation guide to help
you setup a local, development version of Funkwhale. If you only want to fix small things
on the front-end, and don't want to manage a full development environment, there is anoter way.
As the front-end can work with any Funkwhale server, you can work with the front-end only,
and make it talk with an existing instance (like the demo one, or you own instance, if you have one).
If even that is too much for you, you can also make your changes without any development environment,
and open a merge request. We will be able to to review your work easily by spawning automatically a
live version of your changes, thanks to Gitlab Review apps.
Setup front-end only development environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. Clone the repository::
git clone ssh://git@code.eliotberriot.com:2222/funkwhale/funkwhale.git
cd funkwhale
cd front
2. Install [nodejs](https://nodejs.org/en/download/package-manager/) and [yarn](https://yarnpkg.com/lang/en/docs/install/#debian-stable)
3. Install the dependencies::
yarn install
4. Launch the development server::
# this will serve the front-end on http://localhost:8000
WEBPACK_DEVSERVER_PORT=8000 yarn dev
5. Make the front-end talk with an existing server (like https://demo.funkwhale.audio),
by clicking on the corresponding link in the footer
6. Start hacking!
Setup your development environment
----------------------------------
...
...
This diff is collapsed.
Click to expand it.
changes/changelog.d/327.feature
0 → 100644
+
22
−
0
View file @
6c066881
Funkwhale's
front-end
c
an
now point to any instance (#327)
Removed
front-end
and
back-end
coupling
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Eventhough
Funkwhale's
front-end
has
always
been
a
Single Page Application,
talking
to
an
API, it was only able to talk to an API on the same domain.
There
was
no
real
technical
justification
behind
this
(only
lazyness),
and
it
was
also blocking interesting use cases
:
-
Use
multiple
customized
versions
of
the
front-end
with
the
same
instance
-
Use
a
customized version of the front-end with multiple instances
-
Use
a
locally hosted front-end with a remote API, which is especially useful in development
From
now
on,
Funkwhale's
front-end
c
an
connect to any Funkwhale server. You can
change
the
server
you
are
connecting
to
in
the
footer.
Fixing this also unlocked a really interesting feature in our development/review workflow
:
by
leveraging
Gitlab
C
I
and review apps, we are now able to deploy automatically live versions of
a
merge request, making it possible for anyone to review front-end changes easily, without
the
need
to
install
a
local environment.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment