Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 1.78 KB
Raw

Contributing to City Tales

Loving City tales, and want to be a part of team?

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting an issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Please take a moment to review this document in order to make the contribution process straightforward and effective for everyone involved.

All changes happen through Pull Requests

Pull requests are the best way to propose changes. We actively welcome your pull requests:

  • Fork the repo and create your branch from master.
  • If you've added code that should be tested, add some tests' examples.
  • If you've changed APIs, update the documentation.
  • Issue that pull request!

Local Development

To start local development, you need to install the dependencies:

npm install

Then, you can run the following commands:

# Run the app in the development mode.
# Open http://localhost:3000 to view it in the browser.
npm start

# Run the test watcher in an interactive mode.
# By default, runs tests related to files changed since the last commit.
npm test

# Builds the app for production to the build folder.
# It correctly bundles React in production mode and optimizes the build for the best performance.
npm run build

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

NEXT_PUBLIC_API_URL=http://localhost:3000/api

Code of Conduct

We expect everyone to follow our Code of Conduct. Please read it. Please follow it.

License

By contributing, you agree that your contributions will be licensed under its MIT License.