A space for coders
Codú is the ultimate community of web developers to learn, share, and get support for your projects, either big or small. It is the perfect place to sharpen your skills and build your portfolio. In Codú, we're all here to help each other to grow as web developers. Plus, Codú makes it easier to find collaborators for your next big project.
We have a fantastic community growing on Discord. Click here to join!
- Fork the project
- Clone with
git clone https://github.com/YOUR_USERNAME/codu.git. - Navigate to the project directory
cd codu. - Install dependencies with:
npm install- If you have any issues installing dependencies, check your node version against that defined in the
.nvmrc. If you're usingnvm, you can runnvm usebefore installing dependencies.
- Create a
.envfile and add the following variables. You can copy the contents ofsample.envwithcat sample.env > .env.
# This default value is if you run our local docker-compose.yml file to create the database.
DATABASE_URL=postgresql://postgres:[email protected]:5432/postgres
# Setup your GitHub ID & Secret on GitHub: https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps
# For development, make sure you set up this with a Homepage URL of http://localhost:3000/ and an Authorization callback URL of http://localhost:3000/api/auth
GITHUB_ID=YOUR_GITHUB_APP_ID
GITHUB_SECRET=YOUR_GITHUB_APP_SECRET
NEXTAUTH_URL=http://localhost:3000/api/auth
For a more detailed how to guide on setting them up go to the Environment Variables section.
NOTE: Before proceeding, make sure your database is running.
- Setup the tables in the database with Drizzle by running:
npm run db:migrateThe full command can be seen in our package.json file
- Seed the database with some mock data by running:
npm run db:seedThe full command can be seen in our package.json file
- Finally, run the development server:
npm run devAfter completion of above commands, now -
Navigate to http://localhost:3000 in your browser to see the result.
You can start your journey by modifying pages/index.tsx. With Auto-update feature, pages updates as you edit the file.
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
Learn more about API routes here.
The DATABASE_URL is a connection string to a PostgreSQL database (version 15.0).
By default, we point to a database running locally with Docker from our docker-compose.yml file.
To run this file, make sure you have Docker installed and that Docker is running.
Run the command docker compose up.
Alternatively, if you have PostgreSQL running locally then you can use your local connection string or grab one from a free service like Supabase.
Currently, we only allow authentication via GitHub. To enable this you need to have a GITHUB_ID and GITHUB_SECRET value.
Setup your GitHub ID & Secret on GitHub:
- Click here to setup New OAuth App and fill in the details as shown below.
For development, make sure you setup this with a Homepage URL of
http://localhost:3000/
and Authorization callback URL of
http://localhost:3000/api/auth
as shown in the image below:
After you click the "Register application" button you should see the GITHUB_ID and be able to generate a new client secret. You can see this in the screenshot below. 👇
After generating the secret, make sure you copy this value to your .env file as this value can not be seen again once you refresh the page. 👇
More info on Authorizing OAuth in the GitHub documentation here.
In order to use Passwordless login locally you need to have a ACCESS_KEY and SECRET_KEY value.
Niall has written a tutorial on how to send emails with AWS SES and shows how to get these values.
Check out the example .env file here to see how to populate these values
Note: Currenly the AWS region of the SNS service is hardcoded to "eu-west-1" it may be necessary to change this if your SNS service is in a different region
You shouldn't need to change the default value here. This is a variable used by Next Auth as the authentication URL to your site.
NEXTAUTH_URL=http://localhost:3000/api/auth
This is the sessionToken uuid that . This is currently hardcoded and there is no reason to change this until we require multiple E2E test users within the same test suite
This is the userId if the E2E user used for testing . This is currently hardcoded and there is no reason to change this until we require multiple E2E test users within the same test suite
For more information, you can read the documentation here. Example .env file can be found here. You can rename this to .env to get started
- Contributions are greatly appreciated. Contributions make the open-source community an amazing place to learn, inspire, and create.
- Check out our contribution guidelines for contributiong to our repo. It includes
- How to Contribute
- How to create a Pull Request
- Run Tests
- Also, Style Guide for Commit Messages
To run the end-to-end tests using Playwright, you need to configure your environment and follow these steps:
Please ensure you have the following variables set in your .env file:
E2E_USER_ID: The id of the E2E user for testing.E2E_USER_EMAIL: The email of the E2E user for testing.E2E_USER_SESSION_ID: The session id that the user will use to authenticate.
Note the sample .env here is fine to use.
First you need to add your E2E test user to your locally running database. Do this by running the following script if you havent already
npm run db:seed
This will create a user and session for your E2E tests. Details of the E2E user created can be seen here
You can run the end-to-end tests using one of the following commands:
For headless mode:
npx playwright testFor UI mode:
npx playwright test --uiTo learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
To learn about the editor shortcuts and hotkeys you can check out this document
You are welcome to open issues to discuss ideas about improving our Codú. Enhancements are encouraged and appreciated.