Git Product home page Git Product logo

githubstars's Introduction

GitHubStars

The project is written in F# but it uses React internally for rendering (Functional components + Hooks), and an architecture similar to Redux for state management (Elmish). The API usage from the UI is minimal for the sake of simplicity (GET and PUT methods only).

Execution

  1. EXPORT GITHUB_API_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx to allow interaction with the public GitHub API from the integration tests and backend
  2. EXPORT API_URL=http://xxx.xxx.xxx.xxx:8086 to compile the frontend container with the correct API URL hardcoded (some environments don't have "localhost" bound as the Docker host)
  3. docker-compose -f docker-compose.integration-tests.yml up --build to execute the tests
  4. docker-compose -f docker-compose.yml up --build to execute the application

Details

  • Database: DOCKER_HOST:5432
  • Backend: http://DOCKER_HOST:8086
  • Frontend: http://DOCKER_HOST:8087

Development environment configuration

  1. Install .NET Core SDK 3.1 and yarn
  2. Run dotnet tool restore to install all developer tools required to build the project
  3. Run dotnet paket restore and yarn --cwd ./src/GitHubStars.Frontend install to download all package dependencies
  4. EXPORT GITHUB_API_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx to allow interaction with the public GitHub API
  5. dotnet run -p ./test/GitHubStars.Backend.Tests/GitHubStars.Backend.Tests.fsproj to run the tests
  6. dotnet fsharplint lint GitHubStars.sln --lint-config ./fsharplint.json to run the linter (Windows only. it can also be configured into an IDE)

githubstars's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.