Spaced Repetition Backend

REST API for Spaced Repetition Frontend app.

View Endpoints Docs.

Run the code locally

1. Clone the repo

   git clone https://github.com/Zeitverschwender/Spaced-Repetition-Backend
   cd Spaced-Repetition-Backend/

2. Duplicate .env.example file and rename it to .env and fill in the required fields.

3. Install requiremnets and start the server.

   npm install
   npm start

Deployment

To deploy the api to a live/production server. You can either use docker, docker-compose or K8s.

Docker

Duplicate .env.example file and rename it to .env and fill in the required fields or pass it through command line arguemnts when running docker run. Change the first part of the tag to your dockerhub id)

docker build -t digitalphoenixx/spacedrepetition-api:latest .
docker run -p 8000:8000 digitalphoenixx/spacedrepetition-api:latest

Replace build tag and port used with appropriate values.

Docker-compose

Duplicate the .env file and fill in the data. Replace the port number in the docker-compose.yml file with preferred port. Then run

docker-compose up

K8s

1. Build the image. (change the first part of the tag to your dockerhub id)

   docker build -t digitalphoenixx/spacedrepetition-api:latest .

2. Change the image name in the .k8s/kustomization.yml to the tag used in the build step.

3. Fill in AUTH_REDIRECT & FRONTEND_URL in .k8s/config.yml.

4. Change the hostname in the .k8s/ingress.yml to your domain.

5. Create deployment.

   kubectl apply -k .k8s/

6. Create the secret with the mongo connection string.

   kubectl create secret generic spacedrepetition-api-secret -n spacedrepetition --from-literal=DB_CONNECTION="VALUE_HERE" --from-literal=GOOGLE_CLIENT_ID="VALUE_HERE" --from-literal=GOOGLE_CLIENT_SECRET="VALUE_HERE" --from-literal=SESSION_SECRET="VALUE_HERE"

7. Check the everything is running, might take a second. Note: Ready is 1/1.

   > kubectl get -n spacedrepetition all
   
   NAME                                                   READY   STATUS    RESTARTS   AGE
   pod/spacedrepetition-api-deployment-6f98dc8b7b-75mvf   1/1     Running   0          19m
   
   NAME                                   TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)    AGE
   service/spacedrepetition-api-service   ClusterIP   10.104.253.223   <none>        8000/TCP   19m
   
   NAME                                              READY   UP-TO-DATE   AVAILABLE   AGE
   deployment.apps/spacedrepetition-api-deployment   1/1     1            1           19m
   
   NAME                                                         DESIRED   CURRENT   READY   AGE
   replicaset.apps/spacedrepetition-api-deployment-6f98dc8b7b   1         1         1       19m

Built With

• VS Code - Code Editor
• Docker Desktop - Containerization

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Sameh Amnoun - Main Dev - SamehAmnoun
• Mohamed Said Sallam - Main Dev - TheDigitalPhoenixX

See also the list of contributors who participated in this project and their work in CONTRIBUTORS.md.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

• README.md Template