Fix readme

2 files changed, 37 insertions, 5 deletions

diff --git a/.env b/.env
new file mode 100644
index 0000000..f4d4c1f
--- /dev/null
+++ b/.env
@@ -0,0 +1 @@
+EXPO_PUBLIC_API_URL=
diff --git a/README.md b/README.md
index 11e2674..6810418 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,47 @@
-# Configuration
+# CAS4 mobile app
+
+This repo refers to a React Native mobile app used for a project for the
+[Context Aware System](https://www.unibo.it/en/study/phd-professional-masters-specialisation-schools-and-other-programmes/course-unit-catalogue/course-unit/2023/479036)
+class at the [University of Bologna](https://unibo.it).
+
+---
+
+## Development
+
+You need:
+- Node `v21.7.1`. We strongly suggest [`fnm`](https://github.com/Schniz/fnm) or
+  [`nvm`](https://github.com/nvm-sh/nvm) for Node versions management.
+- PnpM or NPM (better the first one).
+
+After that you need to edit the `.env` file and set up:
+
+- `EXPO_PUBLIC_API_URL`: refers to the backend URL.
+
+And start the Expo app.
 
 ```
-# .env
-EXPO_PUBLIC_API_URL=
+pnpm run start
 ```
 
-# Set up for android
+## Deployment
+
+This work is made by Expo but you need an extra setup if you want that
+everything go up well.
+
+First of all you log in
+
+```
+eas login
+```
+
+Now you set up [Push Notifications](https://docs.expo.dev/push-notifications/push-notifications-setup/).
+
+### Configuration and Build for Android
 
 1. Generate a release key
 
 ```
-keytool -genkey -v -storetype JKS -keyalg RSA -keysize 2048 -validity 10000 -storepass KEYSTORE_PASSWORD -keypass KEY_PASSWORD -alias cas4 -keystore release.keystore -dname "CN=Santo Cariotti, OU=Unknown, O=Unknown, L=Bologna, ST=Italy, C=IT"
+keytool -genkey -v -storetype JKS -keyalg RSA -keysize 2048 -validity 10000 -storepass KEYSTORE_PASSWORD -keypass KEY_PASSWORD -alias cas4 -keystore release.keystore -dname "CN=John Doe, OU=Unknown, O=Unknown, L=Bologna, ST=Italy, C=IT"
 ```
 
 2. Build Android app