https://github.com/tendaysofclojure/technical-assessment

Last synced: 5 months ago
JSON representation

Host: GitHub
URL: https://github.com/tendaysofclojure/technical-assessment
Owner: TenDaysOfClojure
Created: 2024-11-26T00:01:37.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2025-04-16T05:34:10.000Z (9 months ago)
Last Synced: 2025-06-09T19:49:26.427Z (7 months ago)
Language: Clojure
Homepage:
Size: 4.49 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Technical assessment

## Objective

> Create a Clojure-based web app that allows users to sign up via Facebook, retrieves user details (first name, last name, email, and profile picture), and saves this data to a local database. The profile picture should be retrieved from Facebook and uploaded to Cloudinary, and the Cloudinary URL should be stored in the local database.

## Requirements and Key Features

- User Signup with Facebook
- Implement Facebook Login using the Facebook API
- Retrieve user information such as:
- First Name
- Last Name
- Email Address
- Profile Picture URL
- This will require setting up a Facebook Developer Account and registering an application in development mode to obtain credentials (App ID, Secret)
- Data Storage
- Save the retrieved user details in a database
- The database can be any preferred option
- Profile Picture processing
- Retrieve the user’s profile picture from Facebook using the URL provided via the Facebook API
- Upload the profile picture to Cloudinary
- Save the Cloudinary URL of the uploaded image to the user’s record in the database
- This will require setting up a Cloudinary account to create an API key and secret
- Consider error handling and testing where appropriate

## Development environment

### Database

During development, you can configure the XTDB node type using the `XTDB_NODE_TYPE` environment variable. Two options are available:

1. In-Process Node (`XTDB_NODE_TYPE="in-process"`) which is the default if the environment variable is not provided.
This option runs the XTDB node within your application process. It is ideal for testing, interactive development, REPL experimentation.

In-process data is transiently and will be lost when your REPL or process is termianted.

2. Remote XTDB Server (`XTDB_NODE_TYPE="http://localhost:6543"`) which connects to a remote XTDB server via an HTTP API by specifying the server URL, e.g., http://localhost:6543.

To start a standalone (non-production, non-distributed) XTDB server locally, use the following Docker command:

```
docker run -it --pull=always -p 6543:3000 -p 5432:5432 ghcr.io/xtdb/xtdb
```

By default, data will only be stored transiently within the docker container. To persist data across container restarts, attach a host volume. For example, to persist data to a local directory (e.g. `/tmp/xtdb-data-remote`):

```
docker run -v /tmp/xtdb-data-remote:/var/lib/xtdb -it --pull=always -p 6543:3000 -p 5432:5432 ghcr.io/xtdb/xtdb
```

### Starting a REPL

To start a local nREPL (with CIDER and refactor-nrepl enabled) use the following
commmand in a new terminal:

* Note - see the [Environment Variables Documentation](https://github.com/TenDaysOfClojure/technical-assessment?tab=readme-ov-file#environment-variables-documentation) section for required
environment variables for integration configuration.

```bash
clj -M:repl
```

You can then connect to the local REPL with your preferred editor e.g. Emacs,
VSCode, IntelliJ IDEA etc

For CSS assests see the README in the `css` directory.

### Managing the HTTP server from the REPL

A `dev/scratch.clj` file is provided with code that can start/stop
the HTTP server and perform general tasks.

When connected to the REPL, open the file and evaluate the relevant code.

To confirm if the server is up and running, open a http://localhost:3000 in your browser.

### Running the app locally (non REPL)

To start the HTTP server on the default port (3000), from a new terminal use the following command:

```
clj -M:run
```

### Running tests

To run unit tests, from a new terminal use the following command:

```
clj -A:test
```

### Environment Variables Documentation

The following environment variables are supported:

- **XTDB_NODE_TYPE** - The type of XTDB node to use, either "in-process" (default if environment variable not provided) or the remote node's url e.g. "http://localhost:6543"

- **FACEBOOK_AUTH_APP_ID** - The App ID for Facebook authentication

- **FACEBOOK_AUTH_SECRET** - The client secret for Facebook authentication

- **FACEBOOK_AUTH_REDIRECT_URL** The redirect URI for Facebook authentication. Use "http://localhost:3000/auth/facebook/callback" for local development

- **CLOUDINARY_CLOUD_NAME** The Cloudinary cloud name

- **CLOUDINARY_API_KEY** - The API key for Cloudinary

- **CLOUDINARY_API_SECRET** - The API secret for Cloudinary

- **HTTP_PORT** - Indicates if port that the HTTP server should run on, defaults to 3000

- **PRODUCTION_ENV** - Indicates if the environment is production

### Example of Starting a REPL with Environment Variables

To start a REPL with the required environment variables, you can use the following command:

```sh
FACEBOOK_AUTH_APP_ID=your_facebook_app_id \
FACEBOOK_AUTH_SECRET=your_facebook_secret \
FACEBOOK_AUTH_REDIRECT_URL="http://localhost:3000/auth/facebook/callback" \
CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name \
CLOUDINARY_API_KEY=your_cloudinary_api_key \
CLOUDINARY_API_SECRET=your_cloudinary_api_secret \
clj -M:repl
```

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/tendaysofclojure/technical-assessment

Awesome Lists containing this project

README