To contribute to Hexpm you need to properly set up your development environment.
Also see the client repository: hex. The client uses
hexpm for integration tests, so
hexpm needs to support all versions the client supports. Travis tests ensures that tests are run on all supported versions.
mix setupto install dependencies, create and seed database etc
iex -S mix phx.serverand visit http://localhost:4000/
After this succeeds you should be good to go!
setup alias in mix.exs and sections below for more information or when you run into issues.
PostgreSQL Modules And Version
PostgreSQL version should be >= 9.4, as Hexpm uses the
jsonb type, that is available from PostgreSQL 9.4 onward.
This is located in the "postgresql-contrib" package, however the package name can vary depending on your operating system. If the module is not installed the ecto migrations will fail.
By default, Hexpm connects to a localhost PostgreSQL database
hexpm_dev using the username
postgres with the password
Create the database and user 'postgres' if not already done:
CREATE USER postgres; ALTER USER postgres PASSWORD 'postgres'; CREATE DATABASE hexpm_dev; GRANT ALL PRIVILEGES ON DATABASE hexpm_dev TO postgres; ALTER USER postgres WITH SUPERUSER; -- if you also want to setup the test database CREATE DATABASE hexpm_test; GRANT ALL PRIVILEGES ON DATABASE hexpm_test TO postgres;
Now you are fine to run the ecto migrations:
Using the following command you can seed your local Hexpm instance with some sample data:
mix run priv/repo/seeds.exs
For assets compilation we need to install Node dependencies:
cd assets && yarn install
If you don't have yarn installed,
cd assets && npm install will work too.
Once the database is set up you can start Hexpm:
# with console iex -S mix phx.server # without console mix phx.server
Hexpm will be available at http://localhost:4000/.
Copyright 2015 Six Colors AB Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.