Merge pull request #110 from NeuroJSON/staging

Backend Framework Setup: Database Migrations, Models, and Dataset Interaction Endpoints

Author: elainefan331

.gitignore

@@ -3,4 +3,10 @@ node_modules
 .DS_Store
 package-lock.json
 
-build
+build
+
+#backend
+backend/node_modules/
+backend/.env
+backend/*.sqlite
+!backend/package-lock.json

backend/.env.example

@@ -0,0 +1,23 @@
+# Server Configuration
+PORT=5000
+NODE_ENV=development
+
+# Database Configuration
+# For local development (SQLite)
+DB_DIALECT=sqlite
+DB_STORAGE=./database.sqlite
+
+# For production (PostgreSQL) - uncomment and fill these
+# DB_DIALECT=postgres
+# DB_HOST=localhost
+# DB_PORT=5432
+# DB_NAME=neurojson_db
+# DB_USER=your_username
+# DB_PASSWORD=your_password
+
+# JWT Secret
+JWT_SECRET=your-super-secret-jwt-key-change-this-in-production
+
+# CORS Origin (your React frontend URL)
+CORS_ORIGIN=http://localhost:3000
+

backend/.gitignore

@@ -0,0 +1,28 @@
+# Environment variables
+.env
+.env.local
+.env.*.local
+!.env.example
+
+# Database files (SQLite)
+*.sqlite
+*.sqlite3
+*.db
+
+# Dependencies
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Logs
+logs/
+*.log
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Build output
+dist/
+build/

backend/.sequelizerc

@@ -0,0 +1,9 @@
+// backend/.sequelizerc
+const path = require("path");
+
+module.exports = {
+  config: path.resolve("config", "config.js"),
+  "models-path": path.resolve("src", "models"),
+  "seeders-path": path.resolve("seeders"),
+  "migrations-path": path.resolve("migrations"),
+};

backend/config/config.js

@@ -0,0 +1,29 @@
+require("dotenv").config();
+
+module.exports = {
+  development: {
+    dialect: "sqlite",
+    storage: "./database.sqlite",
+    logging: console.log,
+  },
+  test: {
+    dialect: "sqlite",
+    storage: ":memory:",
+    logging: false,
+  },
+  production: {
+    dialect: "postgres",
+    host: process.env.DB_HOST,
+    port: parseInt(process.env.DB_PORT || "5432"),
+    database: process.env.DB_NAME,
+    username: process.env.DB_USER,
+    password: process.env.DB_PASSWORD,
+    logging: false,
+    pool: {
+      max: 5,
+      min: 0,
+      acquire: 30000,
+      idle: 10000,
+    },
+  },
+};

backend/migrations/20251028184256-create-users.js

@@ -0,0 +1,70 @@
+"use strict";
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    /**
+     * Add altering commands here.
+     *
+     * Example:
+     * await queryInterface.createTable('users', { id: Sequelize.INTEGER });
+     */
+    await queryInterface.createTable("users", {
+      id: {
+        type: Sequelize.INTEGER,
+        autoIncrement: true,
+        primaryKey: true,
+        allowNull: false,
+      },
+      orcid_id: {
+        type: Sequelize.STRING(255),
+        allowNull: true,
+        unique: true,
+      },
+      google_id: {
+        type: Sequelize.STRING(255),
+        allowNull: true,
+        unique: true,
+      },
+      github_id: {
+        type: Sequelize.STRING(255),
+        allowNull: true,
+        unique: true,
+      },
+      username: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+        unique: true,
+      },
+      hashed_password: {
+        type: Sequelize.STRING(255),
+        allowNull: true,
+      },
+      email: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+        unique: true,
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+        defaultValue: Sequelize.literal("CURRENT_TIMESTAMP"),
+      },
+      updated_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+        defaultValue: Sequelize.literal("CURRENT_TIMESTAMP"),
+      },
+    });
+  },
+
+  async down(queryInterface, Sequelize) {
+    /**
+     * Add reverting commands here.
+     *
+     * Example:
+     * await queryInterface.dropTable('users');
+     */
+    await queryInterface.dropTable("users");
+  },
+};

backend/migrations/20251028184358-create-datasets.js

@@ -0,0 +1,37 @@
+"use strict";
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("datasets", {
+      id: {
+        type: Sequelize.INTEGER,
+        autoIncrement: true,
+        primaryKey: true,
+        allowNull: false,
+      },
+      couch_db: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+      },
+      ds_id: {
+        type: Sequelize.STRING(255),
+        allowNull: false,
+      },
+      views_count: {
+        type: Sequelize.INTEGER,
+        allowNull: true,
+        defaultValue: 0,
+      },
+    });
+    // Add unique constraint on couch_db + ds_id
+    await queryInterface.addIndex("datasets", ["couch_db", "ds_id"], {
+      unique: true,
+      name: "datasets_couch_db_ds_id_unique",
+    });
+  },
+
+  async down(queryInterface, Sequelize) {
+    await queryInterface.dropTable("datasets");
+  },
+};

backend/migrations/20251028184628-create-dataset-likes.js

@@ -0,0 +1,50 @@
+"use strict";
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("dataset_likes", {
+      id: {
+        type: Sequelize.INTEGER,
+        autoIncrement: true,
+        primaryKey: true,
+        allowNull: false,
+      },
+      user_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: {
+          model: "users",
+          key: "id",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      },
+      dataset_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: {
+          model: "datasets",
+          key: "id",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+        defaultValue: Sequelize.literal("CURRENT_TIMESTAMP"),
+      },
+    });
+
+    // Add unique constraint to prevent duplicate likes
+    await queryInterface.addIndex("dataset_likes", ["user_id", "dataset_id"], {
+      unique: true,
+      name: "dataset_likes_user_dataset_unique",
+    });
+  },
+
+  async down(queryInterface, Sequelize) {
+    await queryInterface.dropTable("dataset_likes");
+  },
+};

backend/migrations/20251028184649-create-saved-datasets.js

@@ -0,0 +1,50 @@
+"use strict";
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("saved_datasets", {
+      id: {
+        type: Sequelize.INTEGER,
+        autoIncrement: true,
+        primaryKey: true,
+        allowNull: false,
+      },
+      user_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: {
+          model: "users",
+          key: "id",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      },
+      dataset_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: {
+          model: "datasets",
+          key: "id",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+        defaultValue: Sequelize.literal("CURRENT_TIMESTAMP"),
+      },
+    });
+
+    // Add unique constraint to prevent duplicate saves
+    await queryInterface.addIndex("saved_datasets", ["user_id", "dataset_id"], {
+      unique: true,
+      name: "saved_datasets_user_dataset_unique",
+    });
+  },
+
+  async down(queryInterface, Sequelize) {
+    await queryInterface.dropTable("saved_datasets");
+  },
+};

backend/migrations/20251028184704-create-comments.js

@@ -0,0 +1,57 @@
+"use strict";
+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+  async up(queryInterface, Sequelize) {
+    await queryInterface.createTable("comments", {
+      id: {
+        type: Sequelize.INTEGER,
+        autoIncrement: true,
+        primaryKey: true,
+        allowNull: false,
+      },
+      user_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: {
+          model: "users",
+          key: "id",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      },
+      dataset_id: {
+        type: Sequelize.INTEGER,
+        allowNull: false,
+        references: {
+          model: "datasets",
+          key: "id",
+        },
+        onUpdate: "CASCADE",
+        onDelete: "CASCADE",
+      },
+      body: {
+        type: Sequelize.TEXT,
+        allowNull: false,
+      },
+      created_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+        defaultValue: Sequelize.literal("CURRENT_TIMESTAMP"),
+      },
+      updated_at: {
+        type: Sequelize.DATE,
+        allowNull: false,
+        defaultValue: Sequelize.literal("CURRENT_TIMESTAMP"),
+      },
+    });
+
+    // Add indexes for common queries
+    await queryInterface.addIndex("comments", ["dataset_id"]);
+    await queryInterface.addIndex("comments", ["user_id"]);
+  },
+
+  async down(queryInterface, Sequelize) {
+    await queryInterface.dropTable("comments");
+  },
+};