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.
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; ALTER DATABASE hexpm_test SET timezone TO 'UTC';
If you want to use another database, user or password, you can specify the
DEV_DATABASE_URL in the shell before doing development:
Now you are fine to run the ecto migrations:
mix ecto.migrate Hexpm.Repo
Using the following command you can seed your local Hexpm instance with some sample data:
mix run priv/repo/seeds.exs
Also, all of the steps above (creating, migrating, and seeding the database) can be achieved by running:
All the Node dependencies can be installed with
cd assets && npm install
These are needed for asset compilation.
Once the database is set up you can start Hexpm:
# with console iex -S mix phoenix.server # without console mix phoenix.server
Hexpm will be available at http://localhost:4000/.
By default, tests use a PostgreSQL called
hexpm_test see above for setup.
Again, if you want to use another database, user or password, you can specify the
TEST_DATABASE_URL in the shell before running tests:
Test Coverage is currently provided by ExCoveralls.
You can generate the HTML coverage report like so
MIX_ENV=test mix coveralls.html
Or visit the project Coveralls page at https://coveralls.io/github/hexpm/hexpm.
Copyright 2015 Eric Meadows-Jönsson 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.