Hits

A no-nonsense hit count badge generator built with Next.js and FaunaDB.

Usage

To use the generated hit count badge, add the following snippet to your readme file.

![Hit count](https://hits.vercel.app/USER/REPO.svg)

Running locally

# Install dependencies
npm install

# Run local development server on https://localhost:3000/
npm run dev

Deployment instructions

1. Firstly, you'll need to set up the back-end database to store the hit counts.

   1. Head over to https://fauna.org and create an account.

   2. Create a database (Select US as the region - if your region of choice is different, you may need to change the db connection domain over at ./pages/api/[...path].js).

   3. Within the created database, create a collection.

   4. Next, click Indexes on the sidebar and add an index.

      • Name: by_path
      • Terms: data.path
      • Values: data.count
      • Unique: Checked
      • Serialized: Checked

   5. After that, click Functions and add a function with the name getHits. For the function body, copy and paste the below function:

      Query(
        Lambda(
          "path",
          Let(
            { match: Match(Index("by_path"), Var("path")) },
            If(
              Exists(Var("match")),
              Let(
                { doc: Get(Var("match")) },
                Update(Select("ref", Var("doc")), {
                  data: { count: Add(Select(["data", "count"], Var("doc")), 1) }
                })
              ),
              Create(Collection("hitcount"), {
                data: { path: Var("path"), count: 1 }
              })
            )
          )
        )
      )
      

      This function takes a single argument (the path), and adds it to the database if it does not exist, or increments the count if it does.

   6. Finally, hit Security in the sidebar and generate a server secret.

2. Set up the front-end:

   To deploy the Next.js app, you can use a platform like Netlify or Vercel. Add the FaunaDB server secret as an environment variable called FAUNADB_SECRET.

   

License

MIT