Skip to content

guptalab/DNA-Resource-Page

Repository files navigation

DNA Storage Resource Page

Static Badge Static Badge NPM

Welcome to the DNA Resource Page repository! This project is an information gathering website dedicated to providing resources related to research and development in the DNA storage and security field. Users can explore a variety of information, including research papers, articles, books, blogs, companies, courses, patents, research grants, tools, and more.

Tech Stack

We have built this project using Next.js 13 as our full-stack framework, leveraging the power of MUI components for a seamless user interface.

Features

  • Table view of information in different categories
  • Filtering data using keywords and dates
  • User login with Google
  • Requesting CRUD access to manage information
  • Accepted users can create, update, and delete rows in tables

Installation

To set up the project on your local machine, follow these steps:
  • Install Node.js version 20 or above.
  • Clone the repository: git clone https://github.com/guptalab/DNA-Resource-Page.git
  • Install dependencies: npm i
  • Obtain the .env file by reaching out to us at dnaresource@guptalab.org
  • Create an .env.local file in the cloned project (same directory as README.md) and paste the provided environment variables.
  • Run the project: npm run dev
  • This will start the development server on your machine at port 3000 by default.
  • Open your favorite browser and go to http://localhost:3000 to view the locally running website.
Feel free to explore the code, make changes, and contribute to the project. If you identify areas for improvement, such as code restructuring, refactoring, or logic errors, open a pull request, and our team will review it promptly.

Project Structure

The project follows a structured organization to facilitate easy navigation and understanding of the codebase. Here's a brief overview of the main directories:
  • /public: Contains static assets such as images or files used in the project.
  • /src: This is the heart of the application, where the source code resides. Key directories include:
    • /components: Reusable React components used throughout the application.
    • /pages: Next.js pages that define the different routes of the application.
    • /styles: Stylesheets for styling the components and pages.
    • /utils: Utility functions or helper modules used across the application.

Additionally, we encourage contributors to write tests for new features or existing functionality.

Issues/Bugs

If you encounter any bugs or issues while using our application, please report them in the Issues tab of this repository. Our team will work to address and resolve them promptly.

Contribution

We welcome contributions from the community! If you have ideas for new features or improvements, implement them and create a pull request. We appreciate contributions related to UI enhancements. Your efforts will be acknowledged in our contributors' field. Thank you for helping make this project better! 😄

Deployment

The application is deployed using vercel.com which uses a continuous integration and continuous deployment (CI/CD) pipeline to automate the deployment process.

Contact

If you have any questions, suggestions, or just want to say hello, feel free to reach out to us at dnaresource@guptalab.org. We value community feedback and are eager to hear from you!

✨🧬 Happy coding! 🧬✨

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •